Arbor: State Diagram Editor  2.2.0
Parameter Class Reference

Class of Parameter to be stored in the ParameterContainer. More...

Public Types

enum  Type {
  Int, Float, Bool, GameObject,
  String, Vector2 = 1000, Vector3, Quaternion,
  Rect, Bounds, Transform = 2000, RectTransform,
  Rigidbody, Rigidbody2D
}
 Parameter type. More...
 

Public Member Functions

delegate void DelegateOnChanged (Parameter parameter)
 
void OnChanged ()
 Call when you change the value. More...
 
override string ToString ()
 Convert value to string format. More...
 
string ToString (string format)
 Convert value to string format. More...
 

Public Attributes

ParameterContainerInternal container
 Container this parameter is stored. More...
 
int id
 ID. More...
 
Type type
 Type. More...
 
string name
 Name. More...
 
int intValue
 Int value of type. More...
 
float floatValue
 Float value of type. More...
 
bool boolValue
 Bool value of type. More...
 
string stringValue
 String value of type. More...
 
GameObject gameObjectValue
 GameObject value of type. More...
 
Vector2 vector2Value
 Vector2 value of type. More...
 
Vector3 vector3Value
 Vector3 value of type. More...
 
Quaternion quaternionValue
 Quaternion value of type. More...
 
Rect rectValue
 Rect value of type. More...
 
Bounds boundsValue
 Bounds value of type. More...
 
Object objectReferenceValue
 Object value of type. More...
 

Properties

object value [get]
 

Events

DelegateOnChanged onChanged
 Callback function to be called when the value is changed. More...
 

Detailed Description

Class of Parameter to be stored in the ParameterContainer.

Member Enumeration Documentation

enum Type
strong

Parameter type.

Enumerator
Int 

Int type.

Float 

Float type.

Bool 

Bool type.

GameObject 

GameObject type.

String 

String type.

Vector2 

Vector2 type.

Vector3 

Vector3 type.

Quaternion 

Quaternion type.

Rect 

Rect type.

Bounds 

Bounds type.

Transform 

Transform type.

RectTransform 

RectTransform type.

Rigidbody 

Rigidbody type.

Rigidbody2D 

Rigidbody2D type.

Member Function Documentation

delegate void DelegateOnChanged ( Parameter  parameter)
void OnChanged ( )

Call when you change the value.

override string ToString ( )

Convert value to string format.

Returns
Converted string
string ToString ( string  format)

Convert value to string format.

Parameters
formatNumeric format string (Int, Float only)
Returns
Converted string

For more information about numeric format specifiers, see Standard Numeric Format Strings and Custom Numeric Format Strings.

Member Data Documentation

bool boolValue

Bool value of type.

And invoking the OnChanged () after changing.

Bounds boundsValue

Bounds value of type.

And invoking the OnChanged () after changing.

Container this parameter is stored.

float floatValue

Float value of type.

And invoking the OnChanged () after changing.

GameObject gameObjectValue

GameObject value of type.

And invoking the OnChanged () after changing.

int id

ID.

int intValue

Int value of type.

And invoking the OnChanged () after changing.

string name

Name.

Object objectReferenceValue

Object value of type.

And invoking the OnChanged () after changing.

Quaternion quaternionValue

Quaternion value of type.

And invoking the OnChanged () after changing.

Rect rectValue

Rect value of type.

And invoking the OnChanged () after changing.

string stringValue

String value of type.

And invoking the OnChanged () after changing.

Type type

Type.

Vector2 vector2Value

Vector2 value of type.

And invoking the OnChanged () after changing.

Vector3 vector3Value

Vector3 value of type.

And invoking the OnChanged () after changing.

Property Documentation

object value
get

Event Documentation

DelegateOnChanged onChanged

Callback function to be called when the value is changed.