Struct TMPSceneCommand

Namespace

TMPEffects.TMPCommands

Assembly

TMPEffects.dll

Struct defining scene commands.

[Serializable]
public struct TMPSceneCommand : ITMPCommand

Implements

ITMPCommand

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ExecuteInstantly

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

public bool ExecuteInstantly { get; }

Property Value

bool

ExecuteOnSkip

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

public 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 bool ExecuteRepeatable { get; }

Property Value

bool

TagType

public TagType TagType { get; }

Property Value

TagType

Methods

ExecuteCommand(TMPCommandArgs)

Execute the command.

public void ExecuteCommand(TMPCommandArgs args)

Parameters

args TMPCommandArgs

The arguments for the command.

ValidateParameters(IDictionary<string, string>)

Validate the parameters.
Used to validate tags.

public bool ValidateParameters(IDictionary<string, string> parameters)

Parameters

parameters IDictionary<string, string>

The parameters to validate.

Returns

bool

true if the parameters were successfully validated; false otherwise.