SgScene

The root node or container for all scene objects. Manages object hierarchy, updates, and global systems like lighting or audio. Typically created and loaded by the engine to represent a level or game world.

Inherits from

SceneObject

Usage

To use this class, add the following require at the top of your script:

local SgScene = require 'engine/sceneobjects/sgscene'

Reference

create

static create(self, options, parent)

Create a new scene object in the scenegraph.

Parameters

• self
• options (table): A table of options to fill the parameters
• parent (SceneObject): The parent scene object to add this to

Returns

• Promise: promise which will resolve to the created object

Example

-- Options can be omitted. This example shows the defaults,
-- only specify the ones you want different.
SgScene.create({
    active = true,
    name = "",
    transform = Transform.new(),
    layers = {0},
    tags = {}
})

Properties

You can access these properties directly on the object or through :get("propertyName") or :set("propertyName", value) methods.