Detailed Description

action that repeatedly lets a character interact with some object that is also animated plays an animation on the character and another one on an object when the character reaches a certain point
the animation needs to send a START and END message and an ACT message to start the object animation
useful for buttons or levers that reset themselfes

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

Inheritance diagram for AdventureCore.ButtonAction:

Public Member Functions
override bool	CanStart (CharacterActorBase actor)

override void	OnStart (CharacterActorBase actor, bool jumpStart)

override void	OnEnd (CharacterActionBase next)

override void	OnMessage (string parameter)

override string	GetName ()

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

virtual void	OnInput (int parameter)

virtual void	OnInput (Vector2 parameter)

Public Attributes
string	Name

ItemQuantity	Cost

float	Cooldown

string	CharacterTriggerName

PlayableAnimationParameters	CharacterAnimation

Transform	ObjectCharacterTarget

string	ObjectTriggerName

Animator	ObjectAnimator

UnityEvent	Acting

string	StartMessage = "START"

string	ActMessage = "ACT"

string	EndMessage = "END"

Public Attributes inherited from AdventureCore.CharacterActionBase
CharacterInstructionBase[]	Instructions

CharacterActorBase	Owner

CharacterActionInputType	InputType

CharacterActionBase	Next

UnityEvent< string >	MessageReceived

MessageEvent[]	MessageEvents

UnityEvent	Starting

UnityEvent	Ending

Protected Types
enum	ActionState { None , Triggered , Started , Ended }

Protected Member Functions
virtual void	setActionState (ActionState state)

virtual void	onAnimationFinished (PlayableAnimation a)

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)

Properties
bool	HasCost `[get]`

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

Additional Inherited Members
Public Types inherited from AdventureCore.CharacterActionBase
enum	CharacterActionInputType { Perform = 0 , PerformCancel = 1 , Start = 10 , StartCancel = 11 }

Static Protected Member Functions inherited from AdventureCore.CharacterActionBase
static bool	checkMessage (string parameter, string message)

Protected Attributes inherited from AdventureCore.CharacterActionBase
bool	_isDestroyed = false

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)