class BotStateBaseSource

represent weapon state base

Class comes with entry/update/exit hooks that can be overriden in custom states

Class is ready for hierarchic composition, i.e. this state having a sub-machine running under hood. If no m_FSM member is configured, class acts as ordinary plain finite machine state.

Constructors 1

void BotStateBase(Bot bot = NULL, BotStateBase parent = NULL)

References m_Bot, m_Owner, Bot.m_Owner

Show 1 more

, m_ParentState

Members 4

PlayerBase m_Owner

man that this state belongs to

Referenced by BotDestroyEntityInHands.OnEntry(), BotDropEntityInHands.OnEntry(), BotEatEntityInHands.OnEntry()

Show 30 more

, BotHunt.SelectTarget(), BotHunt_Tracking.OnUpdate(), BotOpenEntityInHands.OnEntry(), BotOpenEntityInHands.OnUpdate(), BotPerformAction.OnEntry(), BotSelectZombieTarget.OnUpdate(), BotSelectZombieTarget.SelectTarget(), BotSpawnDead.OnEntry(), BotSpawnEntityInHands.OnEntry(), BotSpawnEntityInHands.OnUpdate(), BotStateBase(), GetPlayerOwner(), BotStateIdle.BotStateIdle(), BotTestAttachAndDropCycle.OnEntry(), BotTestAttachAndDropCycle_Attaching.OnUpdate(), BotTestAttachAndDropCycle_Detaching.OnUpdate(), BotTestItemMoveBackAndForth.OnEntry(), BotTestItemMoveBackAndForth_MoveFromSlotToSlot.OnUpdate(), BotTestSpamUserActions.OnEntry(), BotTestSpamUserActions_GetEntityFromSlot.OnEntry(), BotTestSpamUserActions_GetEntityFromSlot.OnTimeout(), BotTestSpamUserActions_GetEntityFromSlot.OnUpdate(), BotTestSpamUserActions_Start.OnExit(), BotTestSwapG2H.OnEntry(), BotTestSwapInternal.OnEntry(), BotTestSwapInternal.OnUpdate(), BotTestSwapInternalC2H.OnEntry(), BotTestSwapInternalC2H.OnUpdate(), BotTimedWait.OnTimeout(), and BotWaitForEmptyHands.OnUpdate()

Bot m_Bot

bot that this state belongs to

Referenced by Bot_TestSpawnDeadSelectBury.Bot_TestSpawnDeadSelectBury(), Bot_TestSpawnOpen.Bot_TestSpawnOpen(), Bot_TestSpawnOpenDestroy.Bot_TestSpawnOpenDestroy()

Show 14 more

, Bot_TestSpawnOpenDrop.Bot_TestSpawnOpenDrop(), Bot_TestSpawnOpenEat.Bot_TestSpawnOpenEat(), BotHunt.BotHunt(), BotOpenEntityInHands.OnUpdate(), BotSpawnEntityInHands.OnUpdate(), BotStateBase(), BotStateIdle.BotStateIdle(), BotTestAttachAndDropCycle.BotTestAttachAndDropCycle(), BotTestAttachAndDropCycle_Attaching.OnUpdate(), BotTestAttachAndDropCycle_Detaching.OnUpdate(), BotTestItemMoveBackAndForth.BotTestItemMoveBackAndForth(), BotTestSpamUserActions.BotTestSpamUserActions(), BotTimedWait.OnTimeout(), and BotWaitForEmptyHands.OnUpdate()

BotStateBase m_ParentState

hierarchical parent state of this state (or null)

Referenced by BotStateBase(), GetParentState(), SetParentState()

Show 1 more

, BotStateIdle.BotStateIdle()

ref BotFSM m_FSM

nested state machine (or null)

Referenced by Bot_TestSpawnDeadSelectBury.Bot_TestSpawnDeadSelectBury(), Bot_TestSpawnOpen.Bot_TestSpawnOpen(), Bot_TestSpawnOpenDestroy.Bot_TestSpawnOpenDestroy()

Show 14 more

, Bot_TestSpawnOpenDrop.Bot_TestSpawnOpenDrop(), Bot_TestSpawnOpenEat.Bot_TestSpawnOpenEat(), BotHunt.BotHunt(), AddTransition(), GetFSM(), HasFSM(), IsWaitingForActionFinish(), OnAbort(), OnEntry(), OnUpdate(), ProcessEvent(), BotTestAttachAndDropCycle.BotTestAttachAndDropCycle(), BotTestItemMoveBackAndForth.BotTestItemMoveBackAndForth(), and BotTestSpamUserActions.BotTestSpamUserActions()

Methods 15

PlayerBase GetPlayerOwner()

References m_Owner

Referenced by BotHunt.SelectTarget(), BotHunt_Tracking.OnUpdate(), and BotStanceRandomizer.OnUpdate()

void SetParentState(BotStateBase parent)

allows construction of hierarchical state machine

References m_ParentState

BotStateBase GetParentState()

Returns: state that owns this sub-state (or null if plain state)

References m_ParentState

bool HasFSM()

References m_FSM

Referenced by AddTransition(), IsWaitingForActionFinish(), OnAbort()

Show 3 more

, OnEntry(), OnUpdate(), and ProcessEvent()

BotFSM GetFSM()

References m_FSM

bool ProcessEvent(BotEventBase e)

References HasFSM(), HFSMBase.ProcessEvent(), and m_FSM

void AddTransition(FSMTransition<BotStateBase, BotEventBase, BotActionBase, BotGuardBase> t)

adds transition into m_FSM transition table

References HFSMBase.AddTransition(), Error(), HasFSM()

Show 1 more

, m_FSM

void OnEntry(BotEventBase e)

called upon entry to state @NOTE if state has (non-running) sub-machine, it's started on entry

in e: the event that triggered transition to this state

References botDebugPrint(), HasFSM(), HFSMBase.IsRunning()

Show 4 more

, HFSMBase.Start(), typename.ToString(), Class.Type(), and m_FSM

Referenced by Bot_TestSpawnDeadSelectBury.OnEntry(), Bot_TestSpawnOpen.OnEntry(), BotDestroyEntityInHands.OnEntry()

Show 22 more

, BotDropEntityInHands.OnEntry(), BotEatEntityInHands.OnEntry(), BotHunt.OnEntry(), BotHunt_Hunting.OnEntry(), BotHunt_Tracking.OnEntry(), BotOpenEntityInHands.OnEntry(), BotPerformAction.OnEntry(), BotSelectZombieTarget.OnEntry(), BotSpawnDead.OnEntry(), BotSpawnEntityInHands.OnEntry(), BotStanceRandomizer.OnEntry(), BotTestAttachAndDropCycle.OnEntry(), BotTestAttachAndDropCycle_Attaching.OnEntry(), BotTestAttachAndDropCycle_Detaching.OnEntry(), BotTestItemMoveBackAndForth.OnEntry(), BotTestItemMoveBackAndForth_MoveFromSlotToSlot.OnEntry(), BotTestSpamUserActions.OnEntry(), BotTestSwapG2H.OnEntry(), BotTestSwapInternal.OnEntry(), BotTestSwapInternalC2H.OnEntry(), BotTimedWait.OnEntry(), and BotWaitForEmptyHands.OnEntry()

void OnUpdate(float dt)

ongoing behavior, performed while being in the state

@NOTE: this is supposed to be the Do() operation in UML speak

References HFSMBase.GetCurrentState(), HasFSM(), HFSMBase.IsRunning()

Show 2 more

, OnUpdate(), and m_FSM

Referenced by Bot_TestSpawnDeadSelectBury.OnUpdate(), Bot_TestSpawnOpen.OnUpdate(), BotDestroyEntityInHands.OnUpdate()

Show 16 more

, BotDropEntityInHands.OnUpdate(), BotEatEntityInHands.OnUpdate(), BotHunt.OnUpdate(), BotOpenEntityInHands.OnUpdate(), BotPerformAction.OnUpdate(), BotSelectZombieTarget.OnUpdate(), BotSpawnEntityInHands.OnUpdate(), BotStanceRandomizer.OnUpdate(), BotTestAttachAndDropCycle.OnUpdate(), BotTestItemMoveBackAndForth.OnUpdate(), BotTestSpamUserActions.OnUpdate(), BotTestSwapG2H.OnUpdate(), BotTestSwapInternal.OnUpdate(), BotTestSwapInternalC2H.OnUpdate(), BotTimedWait.OnUpdate(), and BotWaitForEmptyHands.OnUpdate()

void OnAbort(BotEventBase e)

called when abort signal arrives

in e: the event that triggered abort from this state

References HFSMBase.Abort(), botDebugPrint(), HasFSM()

Show 4 more

, HFSMBase.IsRunning(), typename.ToString(), Class.Type(), and m_FSM

Referenced by BotDestroyEntityInHands.OnAbort(), BotDropEntityInHands.OnAbort(), BotEatEntityInHands.OnAbort()

Show 8 more

, BotHunt_Hunting.OnAbort(), BotHunt_Tracking.OnAbort(), BotOpenEntityInHands.OnAbort(), BotPerformAction.OnAbort(), BotTestAttachAndDropCycle_Attaching.OnAbort(), BotTestAttachAndDropCycle_Detaching.OnAbort(), BotTestItemMoveBackAndForth_MoveFromSlotToSlot.OnAbort(), and BotWaitForEmptyHands.OnAbort()

void OnExit(BotEventBase e)

called on exit from state

in e: the event that triggered transition from this state

References botDebugPrint(), typename.ToString(), and Class.Type()

bool IsWaitingForActionFinish()

waiting for active animation action/actionType finish

Returns: true if this state or active substate is waiting for finish signal

References HFSMBase.GetCurrentState(), HasFSM(), HFSMBase.IsRunning()

Show 2 more

, IsWaitingForActionFinish(), and m_FSM

bool IsIdle()

idle state does not expect any animation events

Returns: true if this state is idle

void OnSubMachineChanged(BotStateBase src, BotStateBase dst)

called when sub-machine has changed its state

in src: from state (previous)
in dst: to state (current)

void OnStateChanged(BotStateBase src, BotStateBase dst)

called on current state when state machine has changed its state

in src: from state (previous)
in dst: to state (current)