Scene

Description

The Scene API provides some control over what is rendered.

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

Properties

Name Type Summary
shouldRenderAvatars boolean true if avatars are rendered, false if they aren't.
shouldRenderEntities boolean true if entities (domain, avatar, and local) are rendered, false if they aren't.
stage Stage Stage. Read-only.

Deprecated: This property is deprecated and will be removed. Use Zone entities for lighting instead.

Signals

Name Summary
shouldRenderAvatarsChanged Triggered when whether or not avatars are rendered changes.
shouldRenderEntitiesChanged Triggered when whether or not entities are rendered changes.

Signal Details

shouldRenderAvatarsChanged( shouldRenderAvatars )
Returns: Signal

Triggered when whether or not avatars are rendered changes.

Parameters

Name Type Description
shouldRenderAvatars boolean true if avatars are rendered, false if they aren't.
Example

Report when the rendering of avatars changes.

Scene.shouldRenderAvatarsChanged.connect(function (shouldRenderAvatars) {
    print("Should render avatars changed to: " + shouldRenderAvatars);
});
shouldRenderEntitiesChanged( shouldRenderEntities )
Returns: Signal

Triggered when whether or not entities are rendered changes.

Parameters

Name Type Description
shouldRenderEntities boolean true if entities (domain, avatar, and local) are rendered, false if they aren't.