DeckStacker.DSAction Class Reference

Inheritance diagram for DeckStacker.DSAction:

Public Member Functions
void	Execute ()
void	Resolve ()
string	PrintType ()

Protected Member Functions
void	LogAction (string actionMessage)

Protected Attributes
System.Type	_type = null
bool	_actionLogged = false

Detailed Description

Base abstract class for actions.
New actions for the DeckStacker system need to derive from this class.

For more info on DeckStacker actions, check out DSActionQueue.

Also see DSTemplateAction for an easy template to get started writing custom DeckStacker actions.

Member Function Documentation

Execute()

void DeckStacker.DSAction.Execute ( )

abstract

Override this abstract method to call code when this DSAction is at the front of the DSActionQueue's actionQueue.

LogAction()

void DeckStacker.DSAction.LogAction ( string actionMessage )

inlineprotected

When DSDebugSettings.logActions is enabled, this allows the DSAction to print logs to the console.

PrintType()

string DeckStacker.DSAction.PrintType ( )

inline

A more friendly way of typing "_type.ToString()".

Resolve()

void DeckStacker.DSAction.Resolve ( )

inline

Resolving a DSAction removes it from the DSActionQueue.actionQueue, and allows the next DSAction to be executed on the next Update.

Field Documentation

_actionLogged

bool DeckStacker.DSAction._actionLogged = false

protected

Prevents an action from being logged to console multiple times.

_type

System.Type DeckStacker.DSAction._type = null

protected

type is used for logging actions to console.

---

The documentation for this class was generated from the following file:

• DeckStacker/DSCore/Scripts/CoreActions/DSAction.cs