Drag[en]gine Script Module DragonScript  1.23
Dragengine.BaseGameApp.WorldLayerBit Class Reference

Layer masks. More...

Inheritance diagram for Dragengine.BaseGameApp.WorldLayerBit:

Static Public Attributes

static final int audio = 2
 Geometry affectsing audio. More...
 
static final int custom = 3
 First custom layer bit. More...
 
static final int default = 0
 Default layer mask for normal rendering. More...
 
static final int envmap = 1
 Geometry visible in environment maps. More...
 

Detailed Description

Layer masks.

Used to define what scene elements can interact with each other. The following world elements use layer masks:

  • Component
  • Light
  • Camera
  • EnvMapProbe
  • Microphone
  • Speaker

Member Data Documentation

◆ audio

final int Dragengine.BaseGameApp.WorldLayerBit.audio = 2
static

Geometry affectsing audio.

Elements without this layer mask bit set are not affecting sounds propagating from speakers to microphones. Otherwise the skin textures assigned to the element affect the sound propagation if they have appropriate audio properties set. Skin textures can also set an "affects audio" property to prevent particular element textures to affect sound. By using the layer mask bit the entire element is easily excluded from audio processing altogether.

◆ custom

final int Dragengine.BaseGameApp.WorldLayerBit.custom = 3
static

First custom layer bit.

Add any number of layer bits starting with this value to properly support more default layer mask bits added in the future.

◆ default

final int Dragengine.BaseGameApp.WorldLayerBit.default = 0
static

Default layer mask for normal rendering.

◆ envmap

final int Dragengine.BaseGameApp.WorldLayerBit.envmap = 1
static

Geometry visible in environment maps.

Elements without this layer mask bit set are not included in environment map probes even if the graphic module would otherwise do.


The documentation for this class was generated from the following file: