Detailed Description

action for holding up a weapon(typically a shield) that guards the character from damage

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

Inheritance diagram for AdventureSouls.SoulsGuardAction:

Public Member Functions
override bool	CanStart (CharacterActorBase actor)

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

override bool	CanEnd (CharacterActionBase next)

override void	OnEnd (CharacterActionBase next)

void	Impact ()

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)

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 (bool parameter)

virtual void	OnInput (int parameter)

virtual void	OnInput (Vector2 parameter)

virtual string	GetName ()

Public Attributes
float	Stability = 1f

bool	IsRight

Public Attributes inherited from AdventureCore.ControllerActionBase
PlayableAnimationParameters	Controller

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
static int	GUARD_HASH = Animator.StringToHash("Guard")

static int	GUARD_RIGHT_HASH = Animator.StringToHash("GuardRight")

static int	GUARD_IMPACT_HASH = Animator.StringToHash("GuardImpact")

static int	GUARD_BREAK_HASH = Animator.StringToHash("GuardBreak")

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.ControllerActionBase
override void	OnDestroy ()

virtual void	createAnimation ()

virtual void	cancelAnimation ()

virtual void	endAnimation (CharacterActionBase _)

virtual void	onAnimationFinished (PlayableAnimation a)

override void	setTrigger (int id)

override void	setBool (int id, bool value)

override void	setInt (int id, int value)

override void	setFloat (int id, float value)

override void	setState (int id)

Protected Member Functions inherited from AdventureCore.CharacterActionBase
virtual void	OnEnable ()

virtual void	OnDisable ()

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.ControllerActionBase
PlayableAnimation	_animation

Protected Attributes inherited from AdventureCore.CharacterActionBase
bool	_isDestroyed = false

Properties inherited from AdventureCore.ControllerActionBase
PlayableAnimation	PlayableAnimation `[get]`

Animator	PlayableAnimationTarget `[get]`

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
Properties inherited from AdventureCore.IPlayAnimation
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)

Member Function Documentation

◆ CanEnd()

override bool AdventureSouls.SoulsGuardAction.CanEnd ( CharacterActionBase next )

virtual

Reimplemented from AdventureCore.CharacterActionBase.

◆ CanStart()

override bool AdventureSouls.SoulsGuardAction.CanStart ( CharacterActorBase actor )

inlinevirtual

Reimplemented from AdventureCore.CharacterActionBase.

◆ OnEnd()

override void AdventureSouls.SoulsGuardAction.OnEnd ( CharacterActionBase next )

inlinevirtual

Reimplemented from AdventureCore.ControllerActionBase.

◆ OnStart()

override void AdventureSouls.SoulsGuardAction.OnStart	(	CharacterActorBase	actor,
		bool	jumpStart = false )

inlinevirtual

Reimplemented from AdventureCore.ControllerActionBase.

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ CanEnd()

◆ CanStart()

◆ OnEnd()

◆ OnStart()