Drag[en]gine Script Module DragonScript Script API  1.0
TemporaryDecal Class Reference
Inheritance diagram for TemporaryDecal:

Public Member Functions

void decreaseTimeToLive (float amount)
Decal getDecal ()
Component getParentComponent ()
float getTimeToLive ()
TemporaryDecal new (Decal decal, Component component)
void setTimeToLive (float ttl)

Detailed Description

Describes a 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.

Roland Pl├╝ss

Member Function Documentation

◆ decreaseTimeToLive()

void decreaseTimeToLive ( float  amount)

Decrease the time to live.

◆ getDecal()

Decal getDecal ( )

Retrieves the decal.

◆ getParentComponent()

Component getParentComponent ( )

Retrieves the parent component or null.

◆ getTimeToLive()

float getTimeToLive ( )

Retrieves the time to live.

◆ new()

TemporaryDecal new ( Decal  decal,
Component  component 

Creates a new temporary decal.

◆ setTimeToLive()

void setTimeToLive ( float  ttl)

Sets the time to live.

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