Skip to content

Latest commit

 

History

History
636 lines (281 loc) · 13.8 KB

reference.md

File metadata and controls

636 lines (281 loc) · 13.8 KB

Reference

Logic

Alternate

Alternates between its activated outputs to pass through its input when it is being re-activated.

Array loop

It loops through each item assigned in an array."Value" give item specified by index's value."Done" calls connectors when it is done looping through the array.

Branch

When activated, activates its "True" or "False" output, according to the state of the plugged-in boolean.

Gate

Logic nodes way to do "if" statements. When activated, it compares if its two inputs are being Equal, Greater Equal, Less Equal, or Not Equal, regardless of variable type, and passes through its red input if the set state is the case.

"And" and "Or" are being used for booleans only, and pass through the input when both bools are true (and) or at least one (or).

Inverse

Bool will become opposite, True will become False, False will become True.

Is True/False

Passes through its activation only if the plugged in boolean is "True"/"False", according to the node.

Is None

Give bool value of null i.e., If it is null then its output true(Doesn't have value), if it is not null then it outputs false(Have value).

Is Not None

Give opposite bool value of null i.e., If it is not null then its output true(Have value), if it is null then it output false(Doesn't have value).

Loop

It is basically for(i in from...to) loop. "Index" give value specified by the index value."Done" is called when it is done looping.

Loop Break

Loop Break terminates loop containing it.

Merge

The "New" button creates new inputs, the "X" one deletes the most bottom one. If it receives on activation from any of its inputs, it will activate its output.

Not

Inverts a plugged in boolean, so if its input is "true" it outputs "false".

Sequence

Its call output in sequential order.

Switch

Check the value on input “in”, When the input value matches Case1, Case 2 or Case 3 value, it will trigger the corresponding output Case 1, Case 2 or Case 3. Click "new" to add more Case Value.

To Bool

Is false when there is no event on input, true when there is an event on input.

While

Its loop through as long as bool specified in "Condition" is same.(i.e., like while(jumping == true){do domething}).

Sleep

Activates the node connected with its output after the float value in seconds after it was activated itself.

Event

On Event

Activates the node(s) being connected to Sent Event or Sent Global Event specified in other node(s) tree.

On Init

Activates the node(s) being connected to it on the first frame of the game.

On Timer

Activates the node(s) being connected to after a Timer countdown on from the beginning of the game, repeatedly when box ticked.

On Update

Activates the node(s) being connected to it every frame.

On Volume Trigger

The lower object-input is used as Volume, the upper one as object-input for the object that enters/leaves/overlaps with it.

Enter-mode: Activates the connected nodes on the frame the object enters the volume, on all other frames it doesn't do that.

Leave-mode: Activates the connected nodes on the frame the object leaves the volume, on all other frames it doesn't do that.

Overlap-mode: Activates the connected nodes on the frame the object overlaps with the volume, on all other frames it doesn't do that.

Activators

On Mouse

Activates the node(s) being connected to it when the set Mouse-button is being started, held down or released, depending on settings.

On Keyboard

Activates the node(s) being connected to it when the set Keyboard-button is being started, held down or released, depending on settings.

States

Mouse

Outputs a bool if the set button is being currently started, hold down, released, moved (true) or not (false).

Mouse Cords

Outputs the X, Y location of the mouse of screen and its movement as Vector, and an integer if the scroll wheel es been moved up (1) or moved down (-1) this frame.

Keyboard

Outputs a bool if the set button is being currently started, hold down, released, (true) or not (false).

Get Transform

Outputs the current transform of the set object. An objects Transform consists out of Vectors for its global location, rotation, and scale.

Get Location

Outputs the current global location of the set object as vector.

Get Rotation

Outputs the current rotation of the set Object as a Vector.

Get Scale

Outputs the current scale of the set object as vector.

Get Object

Searches for an object with the set name in the scene and outputs it.

Get Visible

Outputs a Boolean Value according to the objects current visibility setting in the Outliner. False if invisible, True if visible, even if the Object is not on camera right now.

Get Child

Searches for object with the set name that is currently a child of the set object and outputs it.

Get Children

Outputs all current children of the set object as array of objects.

Get Parent

Outputs the current closest parent of the set object.

Get Group

Searches for a group of objects with the set name and outputs it as an array of objects.

Group

Outputs all objects in the set group as array.

Get Distance

Outputs the current distance between the two set objects as float.

Get Trait

Searches for a Trait with the set name which is applied on the set object and outputs it.

Active Camera

Outputs the current active Camera in your game as object.

Active Scene

Outputs the currently active scene in your game.

Volume Trigger

The lower object-input is used as Volume, the upper one as object-input for the object that enters/leaves/overlaps with it.

Enter-mode: Outputs true on the frame the object enters the volume, on all other frames it outputs false.

Leave-mode: Outputs true on the frame the object leaves the volume, on all other frames it outputs false.

Overlap-mode: Outputs true on the frames the object overlaps with the volume, on all other frames it outputs false.

Values

Get Property

Can be used to receive Properties of other objects, which were set with the "Set Property" node. The properties name and object have to match the inputs of this node.

Variables

Action

TBD

Boolean

Stores a Boolean value. A Boolean value has just two states: True and False.

Colour

Store colour value in RGB/HSV/HEX format.

Dynamic

TBD

Float

Stores a Float value. A Float variable is a number with a limited number of decimals. If your number has more than 3 decimals, the value displayed will be rounded, but when you click on it you can still see the whole number, which will also be used in the game.

Global Object

Gives access to an global Object, which can be used to share information between different Traits.

Group

Get value stored in a group (Under Object tab) in Array form.

Integer

Stores an integer value. These are whole numbers.

Material

Get material of any object specified.

Mesh

Get reference of mesh specified.

Object

Get reference any object specified.

Quaternion

Store quaternion value.

Scene

Get reference of scene specified.

Scene Root

TBD

String

Store string value.

Trait

Get reference of trait specified.

Transform

Store Location, Rotation, Scale value in vector form.

Vector

Store X, Y, Z value in vector.

Actions

Set Variable

When activated, updates the first plugged in Variable to the Value of the second. Automatically converts some variable types.

Translate Object

Moves the set object every frame it is activated by the given Vector.

Set Property

When activated, sets or updates a Property of the given object named after its string input to the Value of its general Variable input (the green one). You do not have to worry about the variable type, you can plug everything it apart from activations.

This node can be used to share Variables between different Traits. If the trait(s) you want to access the variable with are on different objects, use the "Global Object" node to store the data. Every trait can access this one.

Physics

Apply Force

This apply force to the object assigned, where "Force", is direction force is applied in term of Vector.

Apply Force at Location

This applies force to the object assigned, where "Force", is direction force is applied in term of Vector, and where "Location", is the location of the object where force is applied from in term of Vector.

Apply Impulse

This apply impulse to the object assigned, where "Impulse", is direction force is applied in term of Vector.

Apply Impulse at Location

This applies force to the object assigned, where "Impulse", is direction force is applied in term of Vector, and where "Location", is the location of the object where force is applied from in term of Vector.

Cast Physics Ray

This cast physics ray from vector assigned to "From", to vector assigned to "To". "Hit" give the location of an object(object assigned to "Object") it hit to in term of vector.

Get Contacts

This Get contacts of the object with item in the array.

Get First Contact

This Get contact of the object with another object that is assigned with the connector.

Get Gravity

This Get gravity of an object in term of vector.

Get Velocity

This Get Linear and Angular velocity of an object in term of vector.

Has Contact

This gives bool value of contact between two objects that are assigned,i.e., If both objects contact each other than this gives True, and if not it gives False.

On Contact

Contact between two objects that are assigned to:

  1. Overlaps - When this two object completely overlap each other, then the "Out" connector is called.
  2. End - When this two objects contact ends, then the "Out" connector is called.
  3. Begins - When this two objects first contact, then the "Out" connector is called.

Pick Object

When the object that is assigned to is in "Screen Coords" (Screen coord is coordination of screen in (X, Y) in term of vector. Note: "Z" is not used and should be ignored because we don't have 3D screen.) and then "Hit" is called to do something to it.

Set Gravity

On activated, this set gravity in term of vector.

Set Velocity

On activated, this set:

  1. The linear velocity of the object that is assigned to.
  2. Linear Factor velocity of the object that is assigned to.
  3. The angular velocity of the object that is assigned to.
  4. Angular Factor velocity of the object that is assigned to. In term of vector.

Sound

Note: Different between Pause Speaker and Stop Speaker, is that Pause speaker will just pause the speaker and can be resumed by Play Speaker. While Stop Speaker will completely stop it and cannot be resumed by Play Speaker, on doing so the speaker will play sound/music from start.

Pause Speaker

On activating this pause speaker(Object that is assigned to as speaker) from playing sound.

Play Sound

On activated this play sound/music that is assigned to.

Play Speaker

On activated this start speaker(Object that is assigned to as speaker) to play sound.

Stop Speaker

On activated this stop speaker(Object that is assigned to as speaker) to stop playing sound.

Canvas

Note: To get the canvas, be sure that the node(s) and the canvas(UI) is attached to the same object.

Canvas Set Text

On activated it changes the text of element(button, label, etc.).