Class ActionBase
Base class for making input-storable and invokable Actions. This is the very base class for all RuleEngine and Toolbox Actions.
Inherited Members
Namespace: UnityEditor.PixyzPlugin4Unity.Actions
Assembly: Unity.Pixyz.Plugin4Unity.Editor.dll
Syntax
public abstract class ActionBase
Properties
Name | Description |
---|---|
ActionNameRuleEngine | The Action name in the Rule Engine |
ActionNameToolbox | The action name in the Toolbox. |
Color | Color of the Action blocks in the Rule Engine |
DisplayNameRuleEngine | Returns the display name in the context of the RuleEngine(without menu path). |
DisplayNameToolbox | Returns the display name in the context of the ToolBox(without menu path) |
GroupNameRuleEngine | The Group name in the Rule Engine |
GroupNameToolbox | The Group name in the Toolbox |
HelpersMethods | Obsolete |
Icon | Icon to be displayed in Toolbox and Rule Engine. If null, no icon will be displayed. To support light and dark themes: specify light theme path. Dark theme file name should be the same with a "d_" prefix. To support selected and unselected states: selected files names should be the same as main files but with a "s_" prefix. |
Id | The id of the Acton implementation. This id should be unique and is readonly. The id is the actual reference if the Action is serialized (in a set of RuleEngine Rules for example). |
InputType | Specifies what kind of data enters the actions. |
IsAsync | Should the Action be fired in as a Task |
IsInRuleEngine | The path used for the contextual menu in the RuleEngine |
IsInToolbox | Returns true if this Action is available trough the Toolbox. |
IsRunning | Defines if the Action is currently running |
MenuPathRuleEngine | The menu path for the RuleEngine. |
MenuPathToolbox | The menu path for the Toolbox. |
OnActionExecuted | Obsolete callback |
Output | The data the Action outputted |
OutputType | Specifies what kind of data the actions outputs. |
Priority | The order to use when placing this Action in a list. If the value is -1, the display name will be used instead; |
Tooltip | Returns the tooltip. |
Methods
Name | Description |
---|---|
CreateInstance(Type) | Creates an instance of an action |
CreateInstance<T>() | Creates an instance of an action |
Dispose() | Called after action execution. Should be used to dispose of any temporary assets/objects that are no longer needed after the Action execution |
GetErrors() | Virtual method for Error checks before execution. |
GetInfo() | Virtual method for Info checks before execution. |
GetWarnings() | Virtual method for Warning checks before execution. |
Initialize() | Called when the Action is created:
|
Invoke(object) | Invoke the action |
OnValueChanged() | Virtual method for implementing operations when a value changed. |
ReportProgress(float, string) | Report progress to the progress bar. |
Validate(object) | Called to validated/check the new input (new selection in the editor with toolbox action, or before running action in ruleset) |