Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.WorldDecal Class Reference

World Decal. More...

Inheritance diagram for Dragengine.Scenery.WorldDecal:

Classes

class  Instance
 

Public Member Functions

void createDecals (CollisionFilter collisionFilter)
 
void dropDecals ()
 
GameWorld getGameWorld ()
 
UniqueID getID ()
 
WorldDecal new ()
 
void setGameWorld (GameWorld gameWorld)
 
void setID (UniqueID id)
 
void setOrientation (Quaternion orientation)
 
void setPosition (DVector position)
 
void setSize (Vector size)
 
void setSkin (Skin skin)
 
void setVisible (bool visible)
 

Detailed Description

World Decal.

Manages a world decal. World decals are a helper class to help manage decals placed in the world instead of being attached to a component. Such decals can spread across multiple world elements. Each element requires an own copy of the decal to yield the proper result. This class stores the decal definition and creates the correct number of engine decals.

Member Function Documentation

◆ createDecals()

void Dragengine.Scenery.WorldDecal.createDecals ( CollisionFilter  collisionFilter)

Creates the decal instances.

◆ dropDecals()

void Dragengine.Scenery.WorldDecal.dropDecals ( )

Drops the decal instances.

◆ getGameWorld()

GameWorld Dragengine.Scenery.WorldDecal.getGameWorld ( )

Retrieves the game world or null if not attached.

◆ getID()

UniqueID Dragengine.Scenery.WorldDecal.getID ( )

Retrieves the unique id or null if not set.

◆ new()

WorldDecal Dragengine.Scenery.WorldDecal.new ( )

Creates a new world decal.

◆ setGameWorld()

void Dragengine.Scenery.WorldDecal.setGameWorld ( GameWorld  gameWorld)

Sets the game world or null if not attached.

◆ setID()

void Dragengine.Scenery.WorldDecal.setID ( UniqueID  id)

Sets the unique id or null to unset it.

◆ setOrientation()

void Dragengine.Scenery.WorldDecal.setOrientation ( Quaternion  orientation)

Sets the orientation.

◆ setPosition()

void Dragengine.Scenery.WorldDecal.setPosition ( DVector  position)

Sets the position.

◆ setSize()

void Dragengine.Scenery.WorldDecal.setSize ( Vector  size)

Sets the size.

◆ setSkin()

void Dragengine.Scenery.WorldDecal.setSkin ( Skin  skin)

Sets the skin.

◆ setVisible()

void Dragengine.Scenery.WorldDecal.setVisible ( bool  visible)

Sets the visiblity.


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