Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Dragengine.Scenery.ECComposeComponent Class Reference

Composable component for element class. More...

Inheritance diagram for Dragengine.Scenery.ECComposeComponent:

Public Member Functions

Component createComponent (Element element, StubElement stub)
 Initialize component for element from stub.
 
LayerMask createLayerMask (StubElement stub)
 Create component layer mask.
 
ECPBoolean getAffectsAudio ()
 Prop affects audio.
 
ECPModel getAudioModel ()
 Audio model resource.
 
ECPBoolean getEnableGI ()
 Enable GI in graphic module if supported.
 
ECPInteger getHintGIImportance ()
 GI important hint.
 
ECPEnumeration getHintMovement ()
 Hint movement.
 
LayerMask getLayerMask ()
 Layer mask to set (basic layer mask).
 
LayerMask getLayerMaskAffectsAudio ()
 Layer mask to set if affects audio is true.
 
LayerMask getLayerMaskRenderEnvMap ()
 Layer mask to set if render environment map is true.
 
ECPModel getModel ()
 Model resource.
 
ECPOcclusionMesh getOcclusionMesh ()
 Occlusion mesh resource.
 
String getPrefix ()
 Property prefix.
 
ECPBoolean getRenderEnvMap ()
 Render prop in environment maps.
 
ECPRig getRig ()
 Rig resource.
 
ECPSkin getSkin ()
 Skin resource.
 
ECPTextureReplacementList getTextureReplacements ()
 Texture replacements.
 
ECComposeComponent new (ElementClass ownerClass)
 Create composable element class.
 
ECComposeComponent new (ElementClass ownerClass, ECPTextureReplacementList textureReplacement)
 Create composable element class.
 
ECComposeComponent new (ElementClass ownerClass, ECPTextureReplacementList textureReplacement, String prefix)
 Create composable element class.
 
ECComposeComponent new (ElementClass ownerClass, String prefix)
 Create composable element class.
 
void replaceTextures (Component component, StubElement stub)
 Replace textures using element class and a stub.
 
void setLayerMask (LayerMask layerMask)
 Set layer mask to set (basic layer mask).
 
void setLayerMaskAffectsAudio (LayerMask layerMask)
 Set layer mask to set if affects audio is true.
 
void setLayerMaskRenderEnvMap (LayerMask layerMask)
 Set layer mask to set if render environment map is true.
 

Public Attributes

ECPBoolean pAffectsAudio
 
ECPModel pAudioModel
 
ECPBoolean pEnableGI
 
ECPInteger pHintGIImportance
 
ECPEnumeration pHintMovement
 
LayerMask pLayerMask
 
LayerMask pLayerMaskAffectsAudio
 
LayerMask pLayerMaskRenderEnvMap
 
ECPModel pModel
 
ECPOcclusionMesh pOcclusionMesh
 
String pPrefix
 
ECPBoolean pRenderEnvMap
 
ECPRig pRig
 
ECPSkin pSkin
 
ECPTextureReplacementList pTextureReplacements
 

Detailed Description

Composable component for element class.

Provides component support to element class without subclassing from a specific class.

Member Function Documentation

◆ createComponent()

Component Dragengine.Scenery.ECComposeComponent.createComponent ( Element  element,
StubElement  stub 
)

Initialize component for element from stub.

◆ createLayerMask()

LayerMask Dragengine.Scenery.ECComposeComponent.createLayerMask ( StubElement  stub)

Create component layer mask.

◆ getAffectsAudio()

ECPBoolean Dragengine.Scenery.ECComposeComponent.getAffectsAudio ( )

Prop affects audio.

◆ getAudioModel()

ECPModel Dragengine.Scenery.ECComposeComponent.getAudioModel ( )

Audio model resource.

◆ getEnableGI()

ECPBoolean Dragengine.Scenery.ECComposeComponent.getEnableGI ( )

Enable GI in graphic module if supported.

Version
1.19

◆ getHintGIImportance()

ECPInteger Dragengine.Scenery.ECComposeComponent.getHintGIImportance ( )

GI important hint.

Version
1.19

Value is in the range from 0 (very unimportant) to 4 (very important). This hint can be used by the graphic module to improve performance by excluding components with a GI important below a user chosen threashold. The default important is 4.

◆ getHintMovement()

ECPEnumeration Dragengine.Scenery.ECComposeComponent.getHintMovement ( )

Hint movement.

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECComposeComponent.getLayerMask ( )

Layer mask to set (basic layer mask).

◆ getLayerMaskAffectsAudio()

LayerMask Dragengine.Scenery.ECComposeComponent.getLayerMaskAffectsAudio ( )

Layer mask to set if affects audio is true.

◆ getLayerMaskRenderEnvMap()

LayerMask Dragengine.Scenery.ECComposeComponent.getLayerMaskRenderEnvMap ( )

Layer mask to set if render environment map is true.

◆ getModel()

ECPModel Dragengine.Scenery.ECComposeComponent.getModel ( )

Model resource.

◆ getOcclusionMesh()

ECPOcclusionMesh Dragengine.Scenery.ECComposeComponent.getOcclusionMesh ( )

Occlusion mesh resource.

◆ getPrefix()

String Dragengine.Scenery.ECComposeComponent.getPrefix ( )

Property prefix.

◆ getRenderEnvMap()

ECPBoolean Dragengine.Scenery.ECComposeComponent.getRenderEnvMap ( )

Render prop in environment maps.

◆ getRig()

ECPRig Dragengine.Scenery.ECComposeComponent.getRig ( )

Rig resource.

◆ getSkin()

ECPSkin Dragengine.Scenery.ECComposeComponent.getSkin ( )

Skin resource.

◆ getTextureReplacements()

ECPTextureReplacementList Dragengine.Scenery.ECComposeComponent.getTextureReplacements ( )

Texture replacements.

◆ new() [1/4]

ECComposeComponent Dragengine.Scenery.ECComposeComponent.new ( ElementClass  ownerClass)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [2/4]

ECComposeComponent Dragengine.Scenery.ECComposeComponent.new ( ElementClass  ownerClass,
ECPTextureReplacementList  textureReplacement 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [3/4]

ECComposeComponent Dragengine.Scenery.ECComposeComponent.new ( ElementClass  ownerClass,
ECPTextureReplacementList  textureReplacement,
String  prefix 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [4/4]

ECComposeComponent Dragengine.Scenery.ECComposeComponent.new ( ElementClass  ownerClass,
String  prefix 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ replaceTextures()

void Dragengine.Scenery.ECComposeComponent.replaceTextures ( Component  component,
StubElement  stub 
)

Replace textures using element class and a stub.

◆ setLayerMask()

void Dragengine.Scenery.ECComposeComponent.setLayerMask ( LayerMask  layerMask)

Set layer mask to set (basic layer mask).

◆ setLayerMaskAffectsAudio()

void Dragengine.Scenery.ECComposeComponent.setLayerMaskAffectsAudio ( LayerMask  layerMask)

Set layer mask to set if affects audio is true.

◆ setLayerMaskRenderEnvMap()

void Dragengine.Scenery.ECComposeComponent.setLayerMaskRenderEnvMap ( LayerMask  layerMask)

Set layer mask to set if render environment map is true.

Member Data Documentation

◆ pAffectsAudio

ECPBoolean Dragengine.Scenery.ECComposeComponent.pAffectsAudio

◆ pAudioModel

ECPModel Dragengine.Scenery.ECComposeComponent.pAudioModel

◆ pEnableGI

ECPBoolean Dragengine.Scenery.ECComposeComponent.pEnableGI

◆ pHintGIImportance

ECPInteger Dragengine.Scenery.ECComposeComponent.pHintGIImportance

◆ pHintMovement

ECPEnumeration Dragengine.Scenery.ECComposeComponent.pHintMovement

◆ pLayerMask

LayerMask Dragengine.Scenery.ECComposeComponent.pLayerMask

◆ pLayerMaskAffectsAudio

LayerMask Dragengine.Scenery.ECComposeComponent.pLayerMaskAffectsAudio

◆ pLayerMaskRenderEnvMap

LayerMask Dragengine.Scenery.ECComposeComponent.pLayerMaskRenderEnvMap

◆ pModel

ECPModel Dragengine.Scenery.ECComposeComponent.pModel

◆ pOcclusionMesh

ECPOcclusionMesh Dragengine.Scenery.ECComposeComponent.pOcclusionMesh

◆ pPrefix

String Dragengine.Scenery.ECComposeComponent.pPrefix

◆ pRenderEnvMap

ECPBoolean Dragengine.Scenery.ECComposeComponent.pRenderEnvMap

◆ pRig

ECPRig Dragengine.Scenery.ECComposeComponent.pRig

◆ pSkin

ECPSkin Dragengine.Scenery.ECComposeComponent.pSkin

◆ pTextureReplacements

ECPTextureReplacementList Dragengine.Scenery.ECComposeComponent.pTextureReplacements
The documentation for this class was generated from the following file: