AdventureCore.NavPatrolAction Class Reference

Detailed Description

moves a NavMeshAgentMovement cyclically between the specified points
automatically saves its current index into the movements persister with subkey 'PAT'

https://adventure.softleitner.com/manual/acting

Inheritance diagram for AdventureCore.NavPatrolAction:

Public Member Functions
override void	OnStart (CharacterActorBase actor, bool jumpStart=false)
override void	OnEnd (CharacterActionBase next)
override void	OnInput (bool parameter)
Public Member Functions inherited from AdventureCore.CharacterActionBase
void	BindInput (InputAction inputAction)
void	UnbindInput (InputAction inputAction)
virtual void	Input (InputAction.CallbackContext callbackContext)
virtual void	Input (InputAction.CallbackContext callbackContext, CharacterActorBase actor)
virtual void	InputClick (CharacterActorBase actor)
virtual void	InputDown (CharacterActorBase actor)
virtual void	InputUp (CharacterActorBase actor)
virtual bool	CanStart (CharacterActorBase actor)
virtual bool	CanEnd (CharacterActionBase next)
void	ForceAction (bool jumpStart=false)
	convenience method for inspector events that calls StartAction(bool, bool) with force=true
void	JumpStartAction (bool force=false)
	convenience method for inspector events that calls StartAction(bool, bool) with jumpStart=true
void	StartAction ()
	overload of StartAction(bool, bool) without a return type so it can be found in event triggers in the inspector
bool	StartAction (bool jumpStart=false, bool force=false)
virtual bool	StartAction (CharacterActorBase actor, bool jumpStart=false, bool force=false)
virtual void	EndAction ()
virtual void	AddAction (CharacterActorBase actor)
virtual void	RemoveAction (CharacterActorBase actor)
virtual void	SendCharacterMessages (string e)
virtual void	SendCharacterMessage (string e)
virtual void	MoveCharacter (Transform transform)
virtual void	OnMessage (string parameter)
virtual void	OnInput (int parameter)
virtual void	OnInput (Vector2 parameter)
virtual string	GetName ()

Public Attributes
Transform[]	Positions
int	Index
NavMeshAgentMovement	Movement
float	Speed
Public Attributes inherited from AdventureCore.CharacterActionBase
CharacterInstructionBase[]	Instructions
CharacterActorBase	Owner
CharacterActionInputType	InputType
CharacterActionBase	Next
UnityEvent< string >	MessageReceived
MessageEvent[]	MessageEvents
UnityEvent	Starting
UnityEvent	Ending

Static Public Attributes
const string	PERSISTENCE_SUB_KEY = "PAT"

Events
Action< int >	IndexChanged
Events inherited from AdventureCore.CharacterActionBase
Action< bool >	IsAvailableChanged
	IsAvailable asserts whether an action is availabel at all, even if it can't be started.
Action< bool >	IsHappeningChanged
	fired when the action starts and ends
Action< CharacterActionBase >	CanStartChanged
	fired when whether the action can be started changes
Action< CharacterActionBase >	CanEndChanged
	fired when whether the action can be ended changes some actions can be ended before they end on their own(released motions for example)

Additional Inherited Members
Public Types inherited from AdventureCore.CharacterActionBase
enum	CharacterActionInputType { Perform = 0 , PerformCancel = 1 , Start = 10 , StartCancel = 11 }
Protected Member Functions inherited from AdventureCore.CharacterActionBase
virtual void	OnDestroy ()
virtual void	OnEnable ()
virtual void	OnDisable ()
virtual void	setTrigger (int id)
virtual void	setBool (int id, bool value)
virtual void	setInt (int id, int value)
virtual void	setFloat (int id, float value)
virtual void	setState (int id)
void	onCanStartChanged ()
void	onCanEndChanged ()
void	addInstructions (IEnumerable< CharacterInstructionBase > instructions)
void	removeInstructions (IEnumerable< CharacterInstructionBase > instructions)
void	addInstruction (CharacterInstructionBase instruction)
void	removeInstruction (CharacterInstructionBase instruction)
Static Protected Member Functions inherited from AdventureCore.CharacterActionBase
static bool	checkMessage (string parameter, string message)
Protected Attributes inherited from AdventureCore.CharacterActionBase
bool	_isDestroyed = false
Properties inherited from AdventureCore.CharacterActionBase
CharacterActorBase	Actor [get]
CharacterBase	AssociatedCharacter [get]
	character that owns or is otherwise associted with the object
virtual bool	IsAvailable [get, set]
	IsAvailable asserts whether an action is availabel at all, even if it can't be started.
virtual bool	IsHappening [get]
	whether the action is currently being executed
virtual bool	IsHappeningWithNext [get]
Properties inherited from AdventureCore.ICharacterAssociator

Member Function Documentation

OnEnd()

override void AdventureCore.NavPatrolAction.OnEnd ( CharacterActionBase next )

inlinevirtual

Reimplemented from AdventureCore.CharacterActionBase.

OnInput()

override void AdventureCore.NavPatrolAction.OnInput ( bool parameter )

inlinevirtual

Reimplemented from AdventureCore.CharacterActionBase.

OnStart()

override void AdventureCore.NavPatrolAction.OnStart ( CharacterActorBase actor, bool jumpStart = false )

inlinevirtual

Reimplemented from AdventureCore.CharacterActionBase.