AdventureCore.SerialCharacterActor Class Reference

Detailed Description

base class for any actor that has one active action at a time

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

Inheritance diagram for AdventureCore.SerialCharacterActor:

Public Member Functions
override void	AddAction (CharacterActionBase characterAction)
override void	RemoveAction (CharacterActionBase characterAction)
override void	OnMessage (string parameter)
override void	OnInput (bool parameter)
override void	OnInput (int parameter)
override void	OnInput (Vector2 parameter)
Public Member Functions inherited from AdventureCore.CharacterActorBase
virtual bool	StartAction (string name, bool jumpStart=false, bool force=false)
	attempts to start or queue up an action
virtual void	EndAction (string name)
	ends an action and removes it from the actors current actions usually called by actions and actors as they are in control of their progress
virtual void	AddAction (string name)
	adds a continuing action depending on the actor an added action can be interrupted by a regular action or just be kept running in parallel
virtual void	RemoveAction (string name)
	dicontinues an action added by AddAction(CharacterActionBase)
bool	StartAction (CharacterActionBase characterAction, bool jumpStart=false, bool force=false)
	attempts to start or queue up an action
void	EndAction (CharacterActionBase characterAction)
	ends an action and removes it from the actors current actions usually called by actions and actors as they are in control of their progress
void	AddAction (CharacterActionBase characterAction)
	adds a continuing action depending on the actor an added action can be interrupted by a regular action or just be kept running in parallel
void	RemoveAction (CharacterActionBase characterAction)
	dicontinues an action added by AddAction(CharacterActionBase)
virtual CharacterActionBase	GetAction (string name)
	retrieves an action that is known by its name actions are usually known by being children of the actor

Protected Attributes
List< CharacterActionBase >	_ongoingActions = new List<CharacterActionBase>()

Properties
CharacterActionBase	CurrentAction [get, protected set]
override bool	IsActing [get]
override IEnumerable< CharacterActionBase >	CurrentActions [get]
Properties inherited from AdventureCore.CharacterActorBase
bool	IsActing [get]
IEnumerable< CharacterActionBase >	CurrentActions [get]
Dictionary< string, CharacterActionBase >	ChildActions [get]
bool	InputBool [get]
int	InputInt [get]
Vector2	InputVector [get]
CharacterBase	AssociatedCharacter [get]
	character that owns or is otherwise associted with the object
Properties inherited from AdventureCore.ICharacterAssociator

Additional Inherited Members
Public Types inherited from AdventureCore.CharacterActorBase
enum	OverruleCanStartMode { Forced , Never , Always }
Public Attributes inherited from AdventureCore.CharacterActorBase
CharacterBase	Character
OverruleCanStartMode	OverruleCanStart
UnityEvent< CharacterActionBase >	ActionStarted
UnityEvent< CharacterActionBase >	ActionEnded
UnityEvent	ActionsChanged
Protected Member Functions inherited from AdventureCore.CharacterActorBase
virtual bool	canStart (CharacterActionBase action, bool forced)
virtual void	onActionStarted (CharacterActionBase characterAction)
virtual void	onActionEnded (CharacterActionBase characterAction)
virtual void	onActionsChanged ()
Events inherited from AdventureCore.CharacterActorBase
Action	Idling
	fired after an event has ended an not other action has been started by the end of the frame

Member Function Documentation

OnInput() [1/3]

override void AdventureCore.SerialCharacterActor.OnInput ( bool parameter )

inlinevirtual

Reimplemented from AdventureCore.CharacterActorBase.

OnInput() [2/3]

override void AdventureCore.SerialCharacterActor.OnInput ( int parameter )

inlinevirtual

Reimplemented from AdventureCore.CharacterActorBase.

OnInput() [3/3]

override void AdventureCore.SerialCharacterActor.OnInput ( Vector2 parameter )

inlinevirtual

Reimplemented from AdventureCore.CharacterActorBase.

OnMessage()

override void AdventureCore.SerialCharacterActor.OnMessage ( string parameter )

inlinevirtual

Reimplemented from AdventureCore.CharacterActorBase.