Package plyBloxKit

Classes
class	plyBlockAttribute
	Attribute for Block definitions. More...
class	plyBlockFieldAttribute
	Attribute for Block Field definitions. More...
class	plyEventAttribute
	Attribute for Event definitions. More...
class	Bool_Value
	A block that creates and can return a Boolean value. More...
class	Color_Value
	A block that creates and can return a Color value. More...
class	Component_Value
	A block that creates and can return a UnityEngine.Component value. More...
class	Float_Value
	A block that creates and can return a Float value. More...
class	Int_Value
	A block that creates and can return an Integer value. More...
class	plyBlox_Value
	A block that creates and can return a reference to a plyBlox object. More...
class	plyValue_Block
	This is the base class for Value or Variable type blocks. More...
class	plyVar_Value
	A block that creates and can return a plyVar value. Reference to a plyBlox Variable. More...
class	Rect_Value
	A block that creates and can return a Rect value. More...
class	SpaceEnum_Value
	A block that creates and can return a UnityEngine.Space value. More...
class	String_Value
	A block that creates and can return a String value. More...
class	SystemObject_Value
	A block that creates and can return a System.Object value. More...
class	UnityObject_Value
	A block that creates and can return a UnityEngine.Object value. More...
class	Vector2_Value
	A block that creates and can return a Vector2 value. More...
class	Vector3_Value
	A block that creates and can return a Vector3 value. More...
class	plyEventTrigger
	This class carry info on an Event that can be triggered and the possible params to send. More...
class	plyBlock
	A plyBlock is the most basic of blocks and base class of other block types. A Block is something that is inserted into an Event and is what is executed when the Event is triggered. Have a look at plyBlockAttribute to learn more about the attribute (def.meta data) you need to include for any Block being defined. Also see plyBlockFieldAttribute for Block fields (public variables) that you define. More...
class	plyBlox
	A plyBlox object is the main worker in the plyBlox Visual Scripting kit. It contains all the States, Events and Blocks that gives behaviour to an object. More...
class	plyBloxGlobal
	THe plyBlox System's Global object, containing Global Variables and Blox system settings. More...
class	plyEvent
	Base class for all Event definitions. An Event is part of A plyBlox' State and execute blocks when triggered. How the Event is triggered depends on what kind of Event it is. Have a look at plyEventAttribute to learn more about the Attribute (def.meta data) you need to include for any Event you define. More...
class	plyEventHandler
	Base class for all Event handlers. When defining new Events you also need to define a handler, or handlers, for those events. The Event.HandlerType override is used to specify that this Handler can handle that specific Event. Handlers can obviously handle more than one Event type and is recommended where possible. Since a handler is simply a MonoBehaviour, or Component, it will be added to the GameObject that has an Event, in its plyBlox, that needs to be handled. So you can assume that anything that works in a Behavior will work in the Event Handler, like Update, OnTriggerEnter, etc. More...
class	plyState
	plyBlox can be in one of several states. The designer will use the plyBlox Editor to add States to a blox object. Each state can have several Events that can be triggered. Events execute Blocks when triggered. You should to normally have to deal with this class directly. More...
class	plyVar
	A plyBlox variable. plyBlox has 3 types of variables. Global, which is accessible from anywhere via plyBloxGlobal and belongs to the game project. Local, which belongs to a Blox object. Temporary, which is only valid within an Event and that Event only. More...

Enumerations
enum	VariableScope { VariableScope.Global, VariableScope.Local, VariableScope.Temp }
	Scope of a variable. plyBlox has 3 types of variables. Global, which is accessible from anywhere and belongs to the game project. Local, which belongs to a Blox object. Temporary, which is only valid within an Event and that Event only. More...
enum	BlockType { BlockType.Container, BlockType.Action, BlockType.Variable, BlockType.Condition }
	Types that a Block can be More...
enum	BlockReturn {   BlockReturn.OK, BlockReturn.True, BlockReturn.False, BlockReturn.Break,   BlockReturn.Continue, BlockReturn.Exit, BlockReturn.Error }
	Block return types More...
enum	plySpace { plySpace.Local, plySpace.World }
	Scene space More...
enum	plyVectorType { plyVectorType.Forward, plyVectorType.Up, plyVectorType.Right }
	Vector type More...
enum	plyAxisV2 { plyAxisV2.X, plyAxisV2.Y }
	2D Axis type More...
enum	plyAxisV3 { plyAxisV3.X, plyAxisV3.Y, plyAxisV3.Z }
	3D Axis type More...
enum	plyRectValues { plyRectValues.X, plyRectValues.Y, plyRectValues.Width, plyRectValues.Height }
	Rect component type More...
enum	plySizeValues { plySizeValues.Width, plySizeValues.Height }
	Size value More...
enum	plyEnabledState { plyEnabledState.Enabled, plyEnabledState.Disabled }
	Enabled state of an object More...
enum	plyVisibleState { plyVisibleState.Visible, plyVisibleState.Hidden }
	Visible state of an object More...
enum	plyVisibleState2 { plyVisibleState2.Show, plyVisibleState2.Hide }
	Visible state of an object More...
enum	plyColorValues { plyColorValues.Red, plyColorValues.Green, plyColorValues.Blue, plyColorValues.Alpha }
	Color component type More...
enum	plyRotationLimit { plyRotationLimit.None, plyRotationLimit.RotateOnly, plyRotationLimit.TiltOnly, plyRotationLimit.RollOnly }
	Limit rotation on specific axis More...
enum	VariableType {   VariableType.Bool, VariableType.Int, VariableType.Float, VariableType.String,   VariableType.Rect, VariableType.Color, VariableType.Vector2, VariableType.Vector3,   VariableType.GameObject, VariableType.UnityObject, VariableType.SystemObject }
	The supported variable types. More...
enum	FieldDataType {   FieldDataType.Unknown, FieldDataType.Custom, FieldDataType.Array, FieldDataType.plyBlock,   FieldDataType.Enum, FieldDataType.Bool, FieldDataType.Char, FieldDataType.Int,   FieldDataType.Float, FieldDataType.String, FieldDataType.GameObject, FieldDataType.UnityObject,   FieldDataType.Rect, FieldDataType.Vector2, FieldDataType.Vector3, FieldDataType.Color }
	The supported Block Field types. More...

Enumeration Type Documentation

enum plyBloxKit.BlockReturn

Block return types

Enumerator
OK	The block executed normally.
True	Special case where the block return normally but want to send a value on to the next block. The 'If' block uses this to tell the 'Else' block what the condition result was.
False	Special case where the block return normally but want to send a value on to the next block. The 'If' block uses this to tell the 'Else' block what the condition result was.
Break	Special case where a container type block wants execution to break out of the container and not continue executing contained blocks.
Continue	Special case where a container type blocks want execution to jump to the first block in the container and skip any that might have followed.
Exit	Special case where the block wants execution of any further blocks to immediately stop and the Event be exited.
Error	Special case where a serious enough error occurred that execution of further blocks must stop. The Event is exited.

enum plyBloxKit.BlockType

Types that a Block can be

Enumerator
Container	Container type blocks can contain and execute other blocks.
Action	Action blocks perform specific tasks and then return.
Variable	Variable blocks set a value that can be used by other blocks. Normally used as fields in other blocks.
Condition	Similar to Variable but should only set a Boolean value (True/ False). Normally used as fields in other blocks.

enum plyBloxKit.FieldDataType

The supported Block Field types.

Enumerator
Unknown	An invalid/ unknown field type.
Custom	A custom field type.
Array	An array.
plyBlock	Field takes a plyBlock as value.
Enum	Enum.
Bool	Boolean.
Char	Single Character.
Int	Integer.
Float	Float.
String	String/ Text.
GameObject	Unity GameObject.
UnityObject	Unity Object.
Rect	Rectangle (x, y, w, h)
Vector2	Vector2 (x, y)
Vector3	Vector3 (x, y, z)
Color	Color (r, g, b, a)

enum plyBloxKit.plyAxisV2

2D Axis type

Enumerator
X	X element/ axis of Vector2.
Y	Y element/ axis of Vector2.

enum plyBloxKit.plyAxisV3

3D Axis type

Enumerator
X	X element/ axis of Vector3.
Y	Y element/ axis of Vector3.
Z	Z element/ axis of Vector3.

enum plyBloxKit.plyColorValues

Color component type

Enumerator
Red	Red component of Color.
Green	Green component of Color.
Blue	Blue component of Color.
Alpha	Alpha component of Color.

enum plyBloxKit.plyEnabledState

Enabled state of an object

Enumerator
Enabled	Enabled.
Disabled	Disabled.

enum plyBloxKit.plyRectValues

Rect component type

Enumerator
X	X element of Rect.
Y	Y element of Rect.
Width	Width element of Rect.
Height	Height element of Rect.

enum plyBloxKit.plyRotationLimit

Limit rotation on specific axis

Enumerator
None	no limit
RotateOnly	around Y
TiltOnly	around X
RollOnly	around Z

enum plyBloxKit.plySizeValues

Size value

Enumerator
Width	Width.
Height	Height.

enum plyBloxKit.plySpace

Scene space

Enumerator
Local	Local.
World	World.

enum plyBloxKit.plyVectorType

Vector type

Enumerator
Forward	The forward vector.
Up	The up vector.
Right	The right vector.

enum plyBloxKit.plyVisibleState

Visible state of an object

Enumerator
Visible	Visible.
Hidden	Hidden.

enum plyBloxKit.plyVisibleState2

Visible state of an object

Enumerator
Show	Visible.
Hide	Hidden.

enum plyBloxKit.VariableScope

Scope of a variable. plyBlox has 3 types of variables. Global, which is accessible from anywhere and belongs to the game project. Local, which belongs to a Blox object. Temporary, which is only valid within an Event and that Event only.

Enumerator
Global	Global variables are handled by plyBloxGlobal.
Local	Local variables are unique to the plyBlox object they are defined in.
Temp	Temp variables are only valid in the Event they are defined in.

enum plyBloxKit.VariableType

The supported variable types.

Enumerator
Bool	Boolean.
Int	Integer.
Float	Float.
String	String/Text.
Rect	Rectangle (x, y, width, height)
Color	Color (r, g, b, a)
Vector2	Vector2 (x, y)
Vector3	Vector3 (x, y z)
GameObject	Unity GameObject.
UnityObject	Unity Object (like Component, but also others)
SystemObject	System Object (use for any type not natively supported by variable)