Scene

new Scene()#

Scene is a container for entities. It is used to organize the game objects in the game. SceneManager is used to load and unload scenes. A scene can be used to only load specific entities. If any entity is not part of a scene, it will be loaded by default.

Properties

Name	Type	Description
`id`	number	Id of the scene. This is used to load the scene.

Source: basic/scene.js, line 5

Extends#

Entity

Members#

children :Array.<Entity>#

Children of this entity.

Type:

Array.<Entity>

Inherited From: Entity#children
Source: basic/entity.js, line 51

(protected, readonly) components :Array.<Component>#

Component attached to this entity.

Type:

Array.<Component>

Inherited From: Entity#components
Source: basic/entity.js, line 61

(protected) name :string#

Name of the entity. Names are not processed by the engine. They are used for debugging purposes.

Type:

string

Inherited From: Entity#name
Source: basic/entity.js, line 27

OnSceneLoad#

Called when The scene is loaded

Source: basic/scene.js, line 16

OnSceneLoadAdditive#

Called when the scene is loaded in additive mode

Source: basic/scene.js, line 20

OnSceneUnload#

Called when the scene is unloaded

Source: basic/scene.js, line 18

OnSceneUnloadAdditive#

Called when the scene is unloaded in additive mode

Source: basic/scene.js, line 22

parent :Entity#

Parent Entity of this entity. If this entity is the root entity, this will be null.

Type:

Entity

Inherited From: Entity#parent
Source: basic/entity.js, line 39

Methods#

AddChild(child)#

Adds a child entity to this entity. This checks if the child is already added to the entity. If it is, it will not be added again.

Parameters:

Name	Type	Description
`child`	Entity	The child entity to be added.

Inherited From: Entity#AddChild
Source: basic/entity.js, line 158

Example

CODE

 // Create a new entity
let entity = new Entity("Box");
 
// Create a new child entity
let child = new Entity("Child");
 
// Add the child entity to the parent entity
entity.AddChild(child);

AddChildren(…children)#

Adds multiple child entities to this entity.

Parameters:

Name	Type	Attributes	Description
`children`	Array.<Entity>	<repeatable>	The child entities to be added.

Inherited From: Entity#AddChildren
Source: basic/entity.js, line 183

Example

CODE

 // Create a new entity
let entity = new Entity("Box");
let childEntity1 = new Entity("Child1");
let childEntity2 = new Entity("Child2");
let childEntity3 = new Entity("Child3");
 
// Add the child entities to the parent entity
entity.AddChildren(childEntity1, childEntity2, childEntity3);

AddComponent(component)#

Adds a component to the entity. This checks if the component is already attached to the entity. If it is, it will not be added again.

Parameters:

Name	Type	Description
`component`	Component	The component to be added.

Inherited From: Entity#AddComponent
Source: basic/entity.js, line 136

Example

CODE

 // Add a transform component to the entity
entity.AddComponent(new Transform());

GetChildren() → {Array.<Entity>}#

Get all children of this entity.

Inherited From: Entity#GetChildren
Source: basic/entity.js, line 96

Returns:

The children of this entity.

Type:: Array.<Entity>

GetChildWithComponent(type) → {Entity}#

Gets the child entity with the specified component type.

Parameters:

Name	Type	Description
`type`	Component	The type of the component to be returned.

Inherited From: Entity#GetChildWithComponent
Source: basic/entity.js, line 223

Returns:

The child entity with the specified component type.

Type:: Entity

Example

CODE

 // Get the first child entity with a transform component 
let child = entity.GetChildWithComponent(Transform);

GetComponent(type) → {Component}#

Returns the component of the given type attached to this entity.

Parameters:

Name	Type	Description
`type`	Component	The type of the component to be returned.

Inherited From: Entity#GetComponent
Source: basic/entity.js, line 75

Returns:

The component of the given type attached to this entity.

Type:: Component

Example

CODE

 // Get the transform component of the entity
let transform = entity.GetComponent(Transform);

GetComponentsInChildren(type) → {Array.<Component>}#

Get a component of the given type attached to the children. Returns all the components of the given type attached to all the children.

Parameters:

Name	Type	Description
`type`	Component	The type of the component to be returned.

Inherited From: Entity#GetComponentsInChildren
Source: basic/entity.js, line 201

Returns:

The components of the given type attached to the children.

Type:: Array.<Component>

Example

CODE

 // Get the transform components of all the children of the entity
let transforms = entity.GetComponentsInChildren(Transform);

GetParent() → {Entity}#

Returns the parent of this entity.

Inherited From: Entity#GetParent
Source: basic/entity.js, line 105

Returns:

The parent of this entity.

Type:: Entity

GetTree() → {Object}#

Generate a tree with the children of this entity. Components are not included in the tree.

Inherited From: Entity#GetTree
Source: basic/entity.js, line 242

Returns:

The tree with the children of this entity.

Type:: Object

Example

CODE

 // Generate a tree with the children of the entity
let tree = entity.GetTree();

HasComponent(type) → {boolean}#

Returns true if the entity has a component of the given type.

Parameters:

Name	Type	Description
`type`	Component	The type of the component to be checked.

Inherited From: Entity#HasComponent
Source: basic/entity.js, line 88

Returns:

True if the entity has a component of the given type.

Type:: boolean

Example

CODE

 // Check if the entity has a transform component
let hasTransform = entity.HasComponent(Transform);

RemoveComponent(type)#

Removes the component of the given type from the entity.

Parameters:

Name	Type	Description
`type`	Component	The type of the component to be removed.

Inherited From: Entity#RemoveComponent
Source: basic/entity.js, line 118

Example

CODE

 // Remove the transform component from the entity
entity.RemoveComponent(Transform);

	// Create a new entity
	let entity = new Entity("Box");

	// Create a new child entity
	let child = new Entity("Child");

	// Add the child entity to the parent entity
	entity.AddChild(child);

	// Create a new entity
	let entity = new Entity("Box");
	let childEntity1 = new Entity("Child1");
	let childEntity2 = new Entity("Child2");
	let childEntity3 = new Entity("Child3");

	// Add the child entities to the parent entity
	entity.AddChildren(childEntity1, childEntity2, childEntity3);

	// Add a transform component to the entity
	entity.AddComponent(new Transform());

	// Get the first child entity with a transform component
	let child = entity.GetChildWithComponent(Transform);

	// Get the transform component of the entity
	let transform = entity.GetComponent(Transform);

	// Get the transform components of all the children of the entity
	let transforms = entity.GetComponentsInChildren(Transform);

	// Generate a tree with the children of the entity
	let tree = entity.GetTree();

	// Check if the entity has a transform component
	let hasTransform = entity.HasComponent(Transform);

	// Remove the transform component from the entity
	entity.RemoveComponent(Transform);