Class WaitCommand

Namespace

TMPEffects.TMPCommands.Commands

public class WaitCommand : TMPCommand, ITMPCommand, ITMPParameterValidator, INotifyObjectChanged

Inheritance

object

TMPCommand

WaitCommand

Implements

ITMPCommand

ITMPParameterValidator

INotifyObjectChanged

Inherited Members

TMPCommand.ExecuteCommand(ICommandContext)

TMPCommand.ValidateParameters(IDictionary<string, string>, ITMPKeywordDatabase)

TMPCommand.SetParameters(object, IDictionary<string, string>, ITMPKeywordDatabase)

TMPCommand.GetNewCustomData()

TMPCommand.ObjectChanged

TMPCommand.OnValidate()

TMPCommand.OnDestroy()

TMPCommand.RaiseObjectChanged()

Properties

ExecuteInstantly

Whether the command is executed the moment the TMPWriter begins writing.
Otherwise, it is executed when the TMPWriter shows the character at the corresponding index.

public override bool ExecuteInstantly { get; }

Property Value

bool

ExecuteOnSkip

Whether the command should be executed by the TMPWriter if its text position is skipped over.

public override bool ExecuteOnSkip { get; }

Property Value

bool

ExecuteRepeatable

Whether the command may be executed multiple times if, for example, the TMPWriter is reset to an earlier text position after the command has been executed.
An example for a command that should not be repeatable is one that triggers a quest, or adds an item to the player's inventory.

public override bool ExecuteRepeatable { get; }

Property Value

bool

TagType

The type of command this is.

public override TagType TagType { get; }

Property Value

TagType

Remarks

Index: This type of command is executed when the TMPWriter shows the character at the corresponding index. It does not need to be closed.
Example: This is <!delay=0.01> my text

Block: This type of command is executed when the TMPWriter shows the character at the first corresponding index. It needs to be closed, and will operate on the enclosed text.
Example: This <!show>is my</!show> text

Either: Both applications are valid.