December 11, 2019

ATTRIBUTE( NAME )

Returns the value of an attribute.

name – Name of the attribute.

function init(){
  let speed = this.attribute('Speed');
}

December 12, 2019

0

Animation

This kind of Animation can be created from an Animation script attribute. It’s useful because you can instantiate many copies of the same animation attribute using code. An Animation is two-dimensional. Here’s an example of creating an Animation from an attribute.

    let attribute = this.attribute('Flame');
    let anim = new Animation(attribute, this);

Function	Description
play()	Starts playing the animation from its beginning.
position()	Returns the Animation’s position relative to its Entity.
rotation()	Returns the rotation of the Animation. in degrees.
scale()	Returns the scale of the Animation.
setFrame(value)	Sets the Animation to a specific frame.
setOpacity(value)	Sets the opacity of the Animation.
setPosition(x, y, z)	Sets the position of the Animation.
setRotation(value)	Sets the rotation of the Animation, in degrees.
setScale(x, y, z)	Sets the scale of the Animation.
setVisible(value)	Sets the visibility of the Animation.

play()

Starts playing the animation from its beginning.

Static Function	Description
hideBanner()	Hides a banner ad if it is visible.
isRemoveAdsPurchased()	Returns true if the user has paid to remove ads, and false if not.
isRewardedVideoAvailable()	Returns true if a rewarded video is available to show, and false if not.
showBanner()	Shows a banner ad.
showInterstitial()	Shows an interstitial (video advertisement) to the user.
showRewardedVideo(callback)	Shows Rewarded Video to the user. callback will be triggered when the video ends.

Function	Description
duration()	Returns the duration of the Keyframe Animation Model.
name()	Returns the name of the Keyframe Animation Model.

Function	Description
affectedAsset()	Returns the affected asset of the If Collide node. If the entity collides with another entity of the affected asset type, the If Collide node will trigger its “Collide” output signal.
collisionEntity()	Returns the last Entity that was collided with. Returns Null if there has never been a collision.
mesh()	Returns the collision shape mesh, if the If Collide node has one. Returns null if not.
parentEntity()	Returns the entity that the If Collide node belongs to.
rebuildShape()	This method rebuilds the collision shape of the If Collide node. You must call this when you want a new shape position, rotation, scale, and/or type applied. Warning: this is a costly operation.
setActive(value)	Enables/disables the If Collide node.
setAffectedAsset(value)	Changes the affected asset of the If Collide node.
setMesh(meshModel)	Sets the mesh of the collision shape using a MeshModel script attribute. See attribute() in the Script section for more information.
setMesh(value)	Sets the mesh of the collision shape using a string name. It is recommended to use a MeshModel script attribute instead, to avoid issues with meshes with the same name.
setShapePosition(x, y, z)	Sets the position of the collision shape. Note that you’ll have to call rebuildShape() after using this method for the change to take effect.
setShapeRotation	Sets the rotation of the collision shape. Note that you’ll have to call rebuildShape() after using this method for the change to take effect.
setShapeScale	Sets the scale of the collision shape. Note that you’ll have to call rebuildShape() after using this method for the change to take effect.
setShapeType(type)	Sets the collision shape type. Note that you’ll have to call rebuildShape() after using this method for the change to take effect. It is recommended to use “kHullShape” over “kMeshShape” as it is less memory intensive.
shapePosition()	Returns the position of the collision shape.
shapeRotation()	Returns the rotation of the collision shape.
shapeScale()	Returns the scale of the collision shape.
shapeType()	Returns the type of the collision shape.

Function	Description
addChild(entity)	Makes the specified entity a child of the current Entity.
camera()	Returns the Camera within the world where the Entity exists. This could be a UI camera or a Scene camera.
children()	Returns the array of child Entities that this Entity has.
color()	Returns the color of the Entity’s 3D Model in RGBA (Red, Green, Blue, Alpha) format.
component(name)	Searches for the component with the specified name in the current Entity and returns it if it’s found. Otherwise, returns null.
components()	Returns an array containing all the entity’s components (also known as nodes).
createComponent(type, name)	Creates a new component (Node) and activates it. Currently these components can be created programmatically: Animation, 3D Model, and If Collide. When creating a 3D Model node this way, a mesh must be set before functions like setPosition() can be used on it. Please see setMesh() for more notes on recommended usage.
forceInit()	Forces a newly created Entity to initialize right away.
globalDepth()	Returns the depth of the Entity in a 2D World.
id()	Returns the Entity’s unique id. Each instance of the Entity in the Scene will have a different id.
isCharacter()	Returns if the Entity is a Character (vs an Object).
isRemoved()	Returns if the Entity has been removed or not.
isVisible()	Returns if the Entity is visible.
level()	Returns the LevelSector that the Entity exists in. This refers to the Scene Selector “level” at the bottom of the screen in a 2D/3D World.
linkedEntities()	Returns the array of Entities linked to this one with the Linker.
localAABB()	Returns the local “axis-aligned bounding box” for the Entity. These coordinates form a box with the minimum corner at (left, bottom, near) and the maximum corner at (right, top, far). Useful for checking the size of your Entity and for ray casting.
name()	Returns the Asset name assigned to Entity.
parent()	Returns the Entity’s parent, or null if it doesn’t have one.
physics()	Returns the Physics Component of the Entity. null is returned if physics is not enabled for this Entity (the checkbox on the Start node).
position()	Returns the Entity’s position relative to its parent. If the Entity has no parent, the result of this function will be no different than worldPosition.
remove()	Removes the Entity from the Scene.
removeComponent(component)	Removes the given component on the next frame.
rotation()	Returns the rotation of the Entity (relative to its parent) in degrees (Vec3).
rotationQuat()	Returns the rotation of the Entity (relative to its parent) in Quaternion.
setParent(parent)	Sets the Entity as a child of the given parent entity or scene, removing it from its current parent.
scale()	Returns the scale of the Entity in Vec3.
setAnimate(value)	Enables/disables animation on the Entity. In this case, “animation” is referring to the position, rotation, and scale animations in the editor.
setCastShadows(value)	Enables/disables shadow casting of all 3D Models within the Entity at once.
setColor(r, g, b, a)	Sets the color of every 3D model within the Entity. Uses RGB (Red, Green, Blue) format. The minimum value is 0 and the maximum is 255. For example, {r:0, g:0, b:0} is black and {r:255, g:255, b:255} is white. Alpha is an optional parameter and sets the opacity of the 3D Model.
setGlobalDepth(value)	Set the depth of the Entity in a 2D World.
setOpacity(value)	Sets opacity of every 3D model and animation in the Entity.
setPosition(x, y, z)	Sets the position of the Entity relative to the Entity’s parent. If the Entity has no parent, this sets the world position of the Entity.
setWorldPosition(x, y, z)	Sets the world position of the Entity, not relative to any parent.
setReceiveShadows(value)	Enables/disables shadow receiving of all 3D Models within the Entity at once.
setRotation(x, y, z)	Sets the rotation value of the Entity, in degrees. This will affect the rotation of every 3D Model within the Entity.
setRotationQuat(value)	Sets rotation value in Quaternion.
setScale(x, y, z)	Sets the scale of the Entity. This will affect the scale of every 3D Model within the Entity.
setTexture(name)	Applies a new texture to all 3D Models within the Entity. The texture should be present in Sprite Editor.
setVisible(value)	Sets the visibility of the Entity; true if the Entity is visible, false if not.
transform()	Returns the transformation matrix of the Entity.
transformedAABB()	Returns the relative “axis-aligned bounding box” for the Entity. These coordinates form a box with the minimum corner at (left, bottom, near) and the maximum corner at (right, top, far). Useful for checking the size of your Entity relative to its parent, and for ray casting.
transformedOBB()	Returns the “oriented bounding box” for the Entity relative to its parent. OBB is more precise but more performance-heavy than AABB.
worldAABB()	Returns the world (absolute) “axis-aligned bounding box” for the Entity. These coordinates form a box with the minimum corner at (left, bottom, near) and the maximum corner at (right, top, far). Useful for checking the size of your Entity and for ray casting.
worldOBB()	Returns the “oriented bounding box” for the Entity. OBB is more precise but more performance-heavy than AABB.
worldPosition()	Returns the entity’s position coordinates in the world (absolute position).
worldRotation()	Returns the entity’s rotation in degrees (not relative to its parent).
worldRotationQuat()	Returns the entity’s rotation in Quaternion (not relative to its parent).

Field	Description	Possible Values
name	Required. The name of the attribute or connection.	Any string *do not give two attributes in the same node the same name!
type	Required. What data type the attribute contains.	Asset Animation Boolean Color Dropdown Mesh Number Slider Text Vector2D Vector3D
connection	Required. Whether this attribute is an input or output connection.	Input Output None
editable	Required. Attribute: Whether this attribute is visible & editable in the attribute sidebar. Connection: Whether the name of this connection can be altered.	true false
essential	Optional (defaults to false). If this field is set to true, then this attribute will be displayed on the Entity’s attribute sidebar when clicked in the asset window. You are marking this attribute as important enough to be accessible from the world view instead of just the entity’s mind map.	true false
hasVariance	Optional (for number or vector attributes only). If this field is set to true, then this attribute will display a variance field next to its value. (see Wave node documentation for an example)	true false
self	Optional. If you’d like your node to be able to be referenced by other nodes without using signals, set this to true to make the purple connection circle visible. (See requested() for more information)	“self”: { “visible” : true } “self”: { “visible” : false }
value	Optional field used to define a default value for the attribute. For instance, your Number type attribute could have a default value of 100 with “value”: 100. Value is required for a Dropdown type attribute because all possible values are pre-defined.	Dropdown Example from Advanced Move node: "value": { "default": "kReplace", "options": { "Replace": "kReplace", "Add": "kAdd", "Multiply": "kMultiply" } } Example for a Vector3D attribute (leaving the X and Z values blank with null): “value”: [null, 20, null]
sliderMin sliderMax sliderStepSize sliderDefaultValue	Required fields for a Slider type attribute. sliderMin and sliderMax define the range of the slider, sliderStepSize defines the increment of the slider, and sliderDefaultValue defines the initial value of the slider.	Example of a Slider attribute: { "name": "My Slider", "type": "Slider", "connection": "None", "editable": true, "sliderMin": 0, "sliderMax": 10, "sliderStepSize": 2, "sliderDefaultValue": 2 }

Function	Description
farPlane()	Returns the far render distance of the camera.
fieldOfView()	Returns the field of view of the camera. The field of view is the extent of the observable world that is seen at any given moment.
followForce()	Returns the follow force of the camera. This determines how much ‘force’ the camera follows an object with.
followOffset()	Returns the follow offset of the camera. The camera will follow the object from this many units away.
followThreshold()	Returns the follow threshold of the camera. This determines how far the followed object can get from the camera before it starts moving.
nearPlane()	Returns the near render distance of the camera. This is the minimum distance from the camera that an object will be rendered.
orthoScale()	Returns the orthographic scale of the camera (only works if camera projection is orthographic)
position()	Returns the relative position of the camera. It is important to note that if your camera is set to position follow the Character or Path, that will take precedence over a position set with setPosition(). This function will return {0, 0, 0} until the relative position is changed with setPosition(), even if you adjust the camera position in the settings.
projection()	Returns the projection type of the camera. There are only two possibilities, kPerspective or kOrthogonal.
rotation()	Returns the relative rotation of the camera. It is important to note that if your camera is set to rotation follow the Character or Path, that will take precedence over a rotation set with setRotation(). This function will return {0, 0, 0} until the relative rotation is changed with setRotation(), even if you adjust the rotation of your camera in the settings.
rotationFollowSmooth()	Returns the rotation smoothness of the camera. The range is 0-1. This is like the coefficient of Quaternion.slerp().
screenCenterRay()	Casts a ray based on the center of the Camera. The object returned has the properties origin and direction.
screenRay(point)	Casts a ray based on the given screen point. The object returned has the properties origin and direction. This is useful in coordination with Physic’s World’s rayTest().
screenToWorld(screenPoint)	Converts the given Vec2 screenPoint to a 3D World Position.
setFarPlane(value)	Sets the far render distance of the camera. This is the maximum distance from the camera that an object will be rendered.
setFieldOfView(value)	Sets field of view of the camera. The field of view is the extent of the observable world that is seen at any given moment.
setFollowForce(x, y, z)	Sets the follow force of the camera. This determines how much ‘force’ the camera follows an object with.
setFollowOffset(x, y, z)	Sets the follow offset of the camera. The camera will follow the object from this many units away.
setFollowThreshold(x, y, z)	Sets the follow threshold of the camera. This determines how far the followed object can get from the camera before it starts moving.
setNearPlane(value)	Sets the Near Render Distance of the camera. This is the minimum distance from the camera that an object will be rendered.
setOrthoScale(value)	Sets the orthographic scale of the camera (only works if camera projection is orthographic)
setPosition(x, y, z)	Sets the relative position of the camera. It is important to note that if your camera is set to position follow the Character or Path, that will take precedence over a position set with setPosition(). This function will not override a camera’s position in the settings, but adjust the position relative to the original camera position.
setPositionFollow(value)	Sets which object the Camera will follow. There are four options you can pass. 1. “None” – Camera will not follow anything 2. “Game Path” – Game Path will be followed 3. “Character” – Any Entity that is considered a Character will be followed 4. The Asset attribute that will be followed
setProjection(value)	Sets the projection type of the camera. There are two possibilities: kPerspective or kOrthogonal.
setProjectionMatrix(matrix)	Sets a custom projection matrix.
setRotation(x, y, z)	Sets the relative rotation of the camera. It is important to note that if your camera is set to rotation follow the Character or Path, that will take precedence over a rotation set with setRotation(). This function will not override a camera’s rotation in the settings, but adjust the rotation relative to the original camera rotation.
setRotationFollow(value)	Sets the object whose rotation the Camera will match. There are four options you can pass. “None” – Camera will not match anything for rotation “Game Path” – Game Path’s rotation will be matched “Character” – Any Entity that is considered a Character will be followed for rotation The Asset attribute whose rotation the camera will match
setRotationFollowSmooth(value)	Sets the rotation smoothness of the camera. The range is 0-1. This is like the coefficient of Quaternion.slerp().
setRotationQuat(value)	Sets the “additional” rotation in Quaternion. Note that unlike in Entity, these “setRotation” and “setRotationQuat” are independent, meaning that the result rotation will be a sum of these two.
setWorldPosition(x, y, z)	Sets the actual position of the camera, the same way it is set in the camera settings panel. Note that if the camera is set to follow position of a character or path, this function won’t work. Use setPosition() to change the camera’s position relative to the object it’s following.
worldPosition()	Returns the actual position of the camera. This is the same position as the one set in the camera settings panel.
worldRotation()	Returns the actual rotation of the camera. This is the same rotation as the one set in the camera settings panel.
worldToScreen(x, y, z)	Projects a World (3D) position into Screen (2D) coordinates.

Static Function	Description
play(sound, looped)	Sets the audio track of the Background Music and plays it.
stop()	Stops the Background Music.
setVolume(volume)	Sets the volume of the Background Music, range 0 (muted) to 1 (max).
volume()	Returns the volume of the Background Music, range 0 (muted) to 1 (max).

Function	Description
castsShadow()	Returns whether this 3D Model casts shadow.
color()	Returns the color of the 3D Model.
globalDepth()	Returns the depth of the 3D Model in a 2D World.
isVisible()	Returns if the 3D Model is visible.
localAABB()	Returns the local “axis-aligned bounding box” for the 3D Model. These coordinates form a box with the minimum corner at (left, bottom, near) and the maximum corner at (right, top, far).
mesh()
position()	Returns the 3D Model’s position relative to its Entity.
receivesShadows()	Returns whether this 3D Model receives shadows.
rotation()	Returns the rotation of the 3D model.
scale()	Returns the scale of the 3D model.
setCastShadow(value)	Enables/disables shadow casting of the 3D Model.
setColor(r, g, b, a)	Sets the color of the 3D Model.
setGlobalDepth(value)	Set the depth of the 3D Model in a 2D World.
setMesh(meshModel)	Sets the mesh by using a Mesh Attribute value. A Mesh Attribute can be added to your script node by clicking the script node, then clicking “Add Attribute” in the bottom right of the screen. It is recommended to use this method when setting a mesh programmatically, because it avoids potential issues with multiple meshes with the same name.
setMesh(value)	Sets the mesh by using a string name.
setPosition(x, y, z)	Sets the position {x, y, z} of the 3D Model.
setReceiveShadows(value)	Enables/disables shadow receiving of the 3D Model.
setRotation(x, y, z)	Sets the rotation {x, y, z} of the 3D Model.
setScale(x, y, z)	Sets the scale {x, y, z} of the 3D Model.
setTexture(name)	Sets the texture of the 3D Model. Can be set with the name of the texture or with a texture attribute (see attribute()).
setTextureOffset(x, y)	Sets the offset of the texture assigned to the 3D Model. The texture is repeated if this is used.
setTextureScale(x, y)	Sets the scale of the texture assigned to the 3D Model. If the value is less than 0, the texture will be repeated.
setVisible()	Sets the visibility of the 3D Model.
textureOffset()	Returns the texture offset of the 3D Model.
textureScale()	Returns the texture scale.
transformedAABB()	Returns the relative “axis-aligned bounding box” for the 3D Model. These coordinates form a box with the minimum corner at (left, bottom, near) and the maximum corner at (right, top, far).
transformedOBB()	Returns the “oriented bounding box” for the 3D Model relative to its parent. OBB is more precise but more performance-heavy than AABB.
worldAABB()	Returns the world (absolute) “axis-aligned bounding box” for the 3D Model. These coordinates form a box with the minimum corner at (left, bottom, near) and the maximum corner at (right, top, far).
worldOBB()	Returns the “oriented bounding box” for the 3d Model. OBB is more precise but more performance-heavy than AABB.

attribute() – API Reference

ATTRIBUTE( NAME )

Animation – API Reference

Animation

play()

position()

Returns

rotation()

Returns

scale()

Returns

setFrame(value)

Parameters

setOpacity(value)

Parameters

setPosition(x, y, z)

Parameters

setRotation(value)

Parameters

setScale(x, y, z)

Parameters

setVisible(value)

Parameters

Ads – API Reference

Ads

hideBanner()

isRemoveAdsPurchased()

Returns

isRewardedVideoAvailable()

Returns

showBanner()

showInterstitial()

showRewardedVideo(callback)

Keyframe Animation Model – API Reference

Keyframe Animation Model

duration()

Returns

name()

Returns

If Collide – API Reference

If Collide

affectedAsset()

Returns

collisionEntity()

Returns

mesh()

Returns

parentEntity()

Returns

rebuildShape()

setActive(value)

Parameters

setAffectedAsset(value)

Parameters

setMesh(meshModel)

Parameters

setMesh(value)

Parameters

setShapePosition(x, y, z)

Parameters

setShapeRotation

Parameters

setShapeScale

Parameters

setShapeType(type)

Parameters

shapePosition()

Returns

shapeRotation()

Returns

shapeScale()

Returns

shapeType()

Returns

Entity – API Reference

Entity

addChild(entity)

camera()

Returns

children()