Class TMPCommand

Namespace

TMPEffects.TMPCommands

Assembly

TMPEffects.dll

Base class for commands.

public abstract class TMPCommand : ScriptableObject, ITMPCommand, INotifyObjectChanged

Inheritance

object

Object

ScriptableObject

TMPCommand

Implements

ITMPCommand

INotifyObjectChanged

Derived

DebugCommand

DelayCommand

ShowCommand

SkippableCommand

WaitCommand

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

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 abstract bool ExecuteInstantly { get; }

Property Value

bool

ExecuteOnSkip

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

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

Property Value

bool

TagType

public abstract TagType TagType { get; }

Property Value

TagType

Methods

ExecuteCommand(TMPCommandArgs)

Execute the command.

public abstract void ExecuteCommand(TMPCommandArgs args)

Parameters

args TMPCommandArgs

The arguments for the command.

OnDestroy()

protected virtual void OnDestroy()

OnValidate()

protected virtual void OnValidate()

RaiseObjectChanged()

protected void RaiseObjectChanged()

ValidateParameters(IDictionary<string, string>)

Validate the parameters.
Used to validate tags.

public abstract 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.

Events

ObjectChanged

public event ObjectChangedEventHandler ObjectChanged

Event Type

ObjectChangedEventHandler