C# Class WaveEngine.Components.GameActions.GameAction

Represent a Game Action to perform something

Inheritance: SerializableObject, IGameAction

Exibir arquivo Open project: WaveEngine/Components

Public Properties

Property	Type	Description
IsSkippable	bool

Private Properties

Property	Type	Description
OnParentComplete	void

Public Methods

Method	Description
Cancel ( ) : void	Cancels this instance.
Run ( ) : void	Runs this instance.
ToString ( ) : string	Returns a System.String that represents this instance.
TrySkip ( ) : bool	Skips this instance.

Protected Methods

Method	Description
GameAction ( IGameAction parent, string taskName ) : System	Initializes a new instance of the GameAction class.
GameAction ( string name, Scene scene = null ) : System	Initializes a new instance of the GameAction class.
PerformCancel ( ) : void	Notifies the cancelled.
PerformCompleted ( ) : void	Notifies the completed.
PerformRun ( ) : void	Ons the run.
PerformSkip ( ) : bool	Notifies the skip.

Private Methods

Method	Description
OnParentComplete ( IGameAction parent ) : void	Parent action is completed

Method Details

Cancel() public method

Cancels this instance.

public Cancel ( ) : void
return	void

GameAction() protected method

Initializes a new instance of the GameAction class.

parent task cannot be null. if is a root task, use the other constructor

protected GameAction ( IGameAction parent, string taskName ) : System
parent	IGameAction	The parent.
taskName	string	Name of the task.
return	System

GameAction() protected method

Initializes a new instance of the GameAction class.

protected GameAction ( string name, Scene scene = null ) : System
name	string	Name of the game action.
scene	Scene	The scene
return	System

PerformCancel() protected method

Notifies the cancelled.

protected PerformCancel ( ) : void
return	void

PerformCompleted() protected method

Notifies the completed.

protected PerformCompleted ( ) : void
return	void

PerformRun() protected abstract method

Ons the run.

protected abstract PerformRun ( ) : void
return	void

PerformSkip() protected method

Notifies the skip.

protected PerformSkip ( ) : bool
return	bool

Run() public method

Runs this instance.

When the action state is not correct

public Run ( ) : void
return	void

ToString() public method

Returns a System.String that represents this instance.

public ToString ( ) : string
return	string

TrySkip() public method

Skips this instance.

When the action state is not correct

public TrySkip ( ) : bool
return	bool

Property Details

IsSkippable public_oe property

The skippable

public bool IsSkippable
return	bool