Class WaitCommand
- Namespace
- TMPEffects.TMPCommands.Commands
- Assembly
- TMPEffects.dll
[CreateAssetMenu(fileName = "new WaitCommand", menuName = "TMPEffects/Commands/Wait")]
public class WaitCommand : TMPCommand, ITMPCommand, INotifyObjectChanged
- Inheritance
-
ObjectScriptableObjectWaitCommand
- Implements
- Inherited Members
-
ScriptableObject.SetDirty()ScriptableObject.CreateInstance<T>()Object.GetInstanceID()Object.GetHashCode()Object.Instantiate(Object, Vector3, Quaternion)Object.Instantiate(Object, Vector3, Quaternion, Transform)Object.Instantiate(Object)Object.Instantiate(Object, Transform)Object.Instantiate<T>(T)Object.Instantiate<T>(T, Vector3, Quaternion)Object.Instantiate<T>(T, Vector3, Quaternion, Transform)Object.Instantiate<T>(T, Transform)Object.Destroy(Object)Object.DestroyImmediate(Object)Object.DontDestroyOnLoad(Object)Object.DestroyObject(Object)Object.FindObjectsOfType<T>()Object.FindObjectsByType<T>(FindObjectsSortMode)Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)Object.FindObjectOfType<T>()Object.FindFirstObjectByType<T>()Object.FindAnyObjectByType<T>()Object.FindFirstObjectByType<T>(FindObjectsInactive)Object.FindAnyObjectByType<T>(FindObjectsInactive)Object.ToString()Object.nameObject.hideFlags
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 override bool ExecuteInstantly { get; }
Property Value
ExecuteOnSkip
Whether the command should be executed by the TMPWriter if its text position is skipped over.
public override bool ExecuteOnSkip { get; }
Property Value
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
TagType
public override TagType TagType { get; }
Property Value
Methods
ExecuteCommand(TMPCommandArgs)
Execute the command.
public override void ExecuteCommand(TMPCommandArgs args)
Parameters
args
TMPCommandArgsThe arguments for the command.
ValidateParameters(IDictionary<string, string>)
Validate the parameters.
Used to validate tags.
public override 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.