v3.9.1 Documentation
Fungus.AddForce2D Class Reference

Add force to a Rigidbody2D More...

Inheritance diagram for Fungus.AddForce2D:
Fungus.Command

Public Types

enum  ForceFunction { ForceFunction.AddForce, ForceFunction.AddForceAtPosition, ForceFunction.AddRelativeForce }
 

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

Protected Attributes

Rigidbody2DData rb
 
ForceMode2D forceMode = ForceMode2D.Force
 
ForceFunction forceFunction = ForceFunction.AddForce
 
Vector2Data force
 
FloatData forceScaleFactor = new FloatData(1)
 
Vector2Data atPosition
 
- 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

Add force to a Rigidbody2D

Definition at line 14 of file AddForce2D.cs.

Member Enumeration Documentation

◆ ForceFunction

Enumerator
AddForce 
AddForceAtPosition 
AddRelativeForce 

Definition at line 22 of file AddForce2D.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.AddForce2D.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 70 of file AddForce2D.cs.

◆ GetSummary()

override string Fungus.AddForce2D.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 65 of file AddForce2D.cs.

◆ HasReference()

override bool Fungus.AddForce2D.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 75 of file AddForce2D.cs.

◆ OnEnter()

override void Fungus.AddForce2D.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 44 of file AddForce2D.cs.

Member Data Documentation

◆ atPosition

Vector2Data Fungus.AddForce2D.atPosition
protected

Definition at line 42 of file AddForce2D.cs.

◆ force

Vector2Data Fungus.AddForce2D.force
protected

Definition at line 34 of file AddForce2D.cs.

◆ forceFunction

ForceFunction Fungus.AddForce2D.forceFunction = ForceFunction.AddForce
protected

Definition at line 30 of file AddForce2D.cs.

◆ forceMode

ForceMode2D Fungus.AddForce2D.forceMode = ForceMode2D.Force
protected

Definition at line 20 of file AddForce2D.cs.

◆ forceScaleFactor

FloatData Fungus.AddForce2D.forceScaleFactor = new FloatData(1)
protected

Definition at line 38 of file AddForce2D.cs.

◆ rb

Rigidbody2DData Fungus.AddForce2D.rb
protected

Definition at line 17 of file AddForce2D.cs.


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