Drag[en]gine Script Module DragonScript Script API  1.0
StubWorldDecal Class Reference

Stub for decal. More...

Inheritance diagram for StubWorldDecal:
StubWithProperties ResourceNotifier

Public Member Functions

void createWorldDecal (GameWorld gameWorld, DecalBuilder builder)
 Create world decal from the stub informations. More...
 
void failedLoading (String path, int resourceType)
 Resource has failed loading. More...
 
void finishedLoading (String path, int resourceType, Object resource)
 Resource has finished loading. More...
 
Color getColorTint ()
 Color tint or null to not replace the color tint. More...
 
String getPathSkin ()
 Skin path. More...
 
DVector getPosition ()
 Position. More...
 
Vector getRotation ()
 Rotation. More...
 
Vector getSize ()
 Size. More...
 
Skin getSkin ()
 Skin. More...
 
String getTextureName ()
 Texture name. More...
 
TexMatrix2 getTransform ()
 Texture coordinates transformation or null to not replace the transformation. More...
 
bool getVisible ()
 Visiblity. More...
 
StubWorldDecal new ()
 Create stub decal. More...
 
void preloadResources ()
 Add preload resources. More...
 
void setColorTint (Color color)
 Set color tint or null to not replace the color tint. More...
 
void setCounter (PreloadCounter counter)
 Set counter. More...
 
void setPathSkin (String pathSkin)
 Set skin path. More...
 
void setPosition (DVector position)
 Set position. More...
 
void setRotation (Vector rotation)
 Set rotation. More...
 
void setSize (Vector size)
 Set size. More...
 
void setTextureName (String textureName)
 Set texture name. More...
 
void setTransform (TexMatrix2 transform)
 Set texture coordinates transformation or null to not replace the transformation. More...
 
void setVisible (bool visible)
 Set visibility. More...
 
bool verifyPreloading (Console console)
 Verify resource failed loading and print the problems to the console. More...
 
- Public Member Functions inherited from StubWithProperties
bool getPropertyBoolFor (String key, bool default)
 Boolean property value or default value if absent. More...
 
int getPropertyCount ()
 Number of properties. More...
 
float getPropertyFloatFor (String key, float default)
 Floating point property value or default value if absent. More...
 
int getPropertyIntFor (String key, int default)
 Integer property value or default value if absent. More...
 
Array getPropertyKeys ()
 Property keys (String array). More...
 
String getPropertyValueFor (String key, String default)
 Value of property or default value if absent. More...
 
bool hasPropertyWithKey (String key)
 Property key is present. More...
 
StubWithProperties new ()
 Create stub with properties. More...
 
void setPropertyValueFor (String key, String value)
 Set property. More...
 
Notification

Detailed Description

Stub for decal.

Used during asynchronous loading to hold the settings of a decal until all resources have been loaded.

Member Function Documentation

§ createWorldDecal()

void createWorldDecal ( GameWorld  gameWorld,
DecalBuilder  builder 
)

Create world decal from the stub informations.

§ failedLoading()

void failedLoading ( String  path,
int  resourceType 
)

Resource has failed loading.

Implements ResourceNotifier.

§ finishedLoading()

void finishedLoading ( String  path,
int  resourceType,
Object  resource 
)

Resource has finished loading.

Implements ResourceNotifier.

§ getColorTint()

Color getColorTint ( )

Color tint or null to not replace the color tint.

§ getPathSkin()

String getPathSkin ( )

Skin path.

§ getPosition()

DVector getPosition ( )

Position.

§ getRotation()

Vector getRotation ( )

Rotation.

§ getSize()

Vector getSize ( )

Size.

§ getSkin()

Skin getSkin ( )

Skin.

§ getTextureName()

String getTextureName ( )

Texture name.

§ getTransform()

TexMatrix2 getTransform ( )

Texture coordinates transformation or null to not replace the transformation.

§ getVisible()

bool getVisible ( )

Visiblity.

§ new()

StubWorldDecal new ( )

Create stub decal.

§ preloadResources()

void preloadResources ( )

Add preload resources.

§ setColorTint()

void setColorTint ( Color  color)

Set color tint or null to not replace the color tint.

§ setCounter()

void setCounter ( PreloadCounter  counter)

Set counter.

§ setPathSkin()

void setPathSkin ( String  pathSkin)

Set skin path.

§ setPosition()

void setPosition ( DVector  position)

Set position.

§ setRotation()

void setRotation ( Vector  rotation)

Set rotation.

§ setSize()

void setSize ( Vector  size)

Set size.

§ setTextureName()

void setTextureName ( String  textureName)

Set texture name.

§ setTransform()

void setTransform ( TexMatrix2  transform)

Set texture coordinates transformation or null to not replace the transformation.

§ setVisible()

void setVisible ( bool  visible)

Set visibility.

§ verifyPreloading()

bool verifyPreloading ( Console  console)

Verify resource failed loading and print the problems to the console.

Returns
true if all resources loaded successfully or false otherwise.

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