v3.9.1 Documentation
Fungus.TransformProperty Class Reference

Get or Set a property of a transform component More...

Inheritance diagram for Fungus.TransformProperty:
Fungus.Command

Public Types

enum  GetSet { GetSet.Get, GetSet.Set }
 
enum  Property {
  Property.ChildCount, Property.EulerAngles, Property.Forward, Property.HasChanged,
  Property.HierarchyCapacity, Property.HierarchyCount, Property.LocalEulerAngles, Property.LocalPosition,
  Property.LocalScale, Property.LossyScale, Property.Parent, Property.Position,
  Property.Right, Property.Root, Property.Up
}
 

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
override string GetSummary ()
 Returns the summary text to display in the command inspector. More...
 
override Color GetButtonColor ()
 Return the color for the command background in inspector. More...
 
override bool HasReference (Variable variable)
 Returns true if this command references the variable. More...
 
- Public Member Functions inherited from Fungus.Command
virtual Flowchart GetFlowchart ()
 Returns the Flowchart that this command belongs to. More...
 
virtual void Execute ()
 Execute the command. More...
 
virtual void Continue ()
 End execution of this command and continue execution at the next command. More...
 
virtual void Continue (int nextCommandIndex)
 End execution of this command and continue execution at a specific command index. More...
 
virtual void StopParentBlock ()
 Stops the parent Block executing. More...
 
virtual void OnStopExecuting ()
 Called when the parent block has been requested to stop executing, and this command is the currently executing command. More...
 
virtual void OnCommandAdded (Block parentBlock)
 Called when the new command is added to a block in the editor. More...
 
virtual void OnCommandRemoved (Block parentBlock)
 Called when the command is deleted from a block in the editor. More...
 
virtual void OnExit ()
 Called when this command ends execution. More...
 
virtual void OnReset ()
 Called when this command is reset. More...
 
virtual void GetConnectedBlocks (ref List< Block > connectedBlocks)
 Populates a list with the Blocks that this command references. More...
 
virtual string GetHelpText ()
 Returns the help text to display for this command. More...
 
virtual bool OpenBlock ()
 Return true if this command opens a block of commands. More...
 
virtual bool CloseBlock ()
 Return true if this command closes a block of commands. More...
 
virtual bool IsPropertyVisible (string propertyName)
 Returns true if the specified property should be displayed in the inspector. More...
 
virtual bool IsReorderableArray (string propertyName)
 Returns true if the specified property should be displayed as a reorderable list in the inspector. More...
 
virtual string GetFlowchartLocalizationId ()
 Returns the localization id for the Flowchart that contains this command. More...
 

Public Attributes

GetSet getOrSet = GetSet.Get
 

Protected Attributes

Property property = Property.Position
 
TransformData transformData
 
Variable inOutVar
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Additional Inherited Members

- Properties inherited from Fungus.Command
virtual int ItemId [get, set]
 Unique identifier for this command. More...
 
virtual string ErrorMessage [get]
 Error message to display in the command inspector. More...
 
virtual int IndentLevel [get, set]
 Indent depth of the current commands. More...
 
virtual int CommandIndex [get, set]
 Index of the command in the parent block's command list. More...
 
virtual bool IsExecuting [get, set]
 Set to true by the parent block while the command is executing. More...
 
virtual float ExecutingIconTimer [get, set]
 Timer used to control appearance of executing icon in inspector. More...
 
virtual Block ParentBlock [get, set]
 Reference to the Block object that this command belongs to. More...
 

Detailed Description

Get or Set a property of a transform component

Definition at line 14 of file TransformProperty.cs.

Member Enumeration Documentation

◆ GetSet

Enumerator
Get 
Set 

Definition at line 16 of file TransformProperty.cs.

◆ Property

Enumerator
ChildCount 
EulerAngles 
Forward 
HasChanged 
HierarchyCapacity 
HierarchyCount 
LocalEulerAngles 
LocalPosition 
LocalScale 
LossyScale 
Parent 
Position 
Right 
Root 
Up 

Definition at line 23 of file TransformProperty.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.TransformProperty.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 203 of file TransformProperty.cs.

◆ GetSummary()

override string Fungus.TransformProperty.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 181 of file TransformProperty.cs.

◆ HasReference()

override bool Fungus.TransformProperty.HasReference ( Variable  variable)
virtual

Returns true if this command references the variable.

Used to highlight variables in the variable list when a command is selected.

Reimplemented from Fungus.Command.

Definition at line 208 of file TransformProperty.cs.

◆ OnEnter()

override void Fungus.TransformProperty.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 59 of file TransformProperty.cs.

Member Data Documentation

◆ getOrSet

GetSet Fungus.TransformProperty.getOrSet = GetSet.Get

Definition at line 21 of file TransformProperty.cs.

◆ inOutVar

Variable Fungus.TransformProperty.inOutVar
protected

Definition at line 57 of file TransformProperty.cs.

◆ property

Property Fungus.TransformProperty.property = Property.Position
protected

Definition at line 47 of file TransformProperty.cs.

◆ transformData

TransformData Fungus.TransformProperty.transformData
protected

Definition at line 50 of file TransformProperty.cs.


The documentation for this class was generated from the following file: