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

Temporary decal attached to a component. More...

Inheritance diagram for Dragengine.Scenery.TemporaryDecal:

Public Member Functions

void decreaseTimeToLive (float amount)
 Decrease time to live. More...
 
Decal getDecal ()
 Decal. More...
 
Component getParentComponent ()
 Parent component or null. More...
 
float getTimeToLive ()
 Time to live. More...
 
TemporaryDecal new (Decal decal, Component component)
 Create temporary decal. More...
 
void setTimeToLive (float ttl)
 Set time to live. More...
 

Detailed Description

Temporary decal attached to a component.

Typical temporary decals are weapon damages. To avoid hogging memory and loosing speed these temporary decals only stay alive for a given amount of time before they are removed. Since most of the time temporary decals are based on their living time a timer parameter is already included. The default interpretation of this parameter is to indicate the time to live in seconds.

Member Function Documentation

◆ decreaseTimeToLive()

void Dragengine.Scenery.TemporaryDecal.decreaseTimeToLive ( float  amount)

Decrease time to live.

◆ getDecal()

Decal Dragengine.Scenery.TemporaryDecal.getDecal ( )

◆ getParentComponent()

Component Dragengine.Scenery.TemporaryDecal.getParentComponent ( )

Parent component or null.

◆ getTimeToLive()

float Dragengine.Scenery.TemporaryDecal.getTimeToLive ( )

Time to live.

◆ new()

TemporaryDecal Dragengine.Scenery.TemporaryDecal.new ( Decal  decal,
Component  component 
)

Create temporary decal.

◆ setTimeToLive()

void Dragengine.Scenery.TemporaryDecal.setTimeToLive ( float  ttl)

Set time to live.


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