Drag[en]gine Script Module DragonScript  1.23
Dragengine.Preloading.StubWorldDecal Class Reference

Stub for decal. More...

Inheritance diagram for Dragengine.Preloading.StubWorldDecal:
Dragengine.Preloading.StubWithProperties Dragengine.ResourceListener

Public Member Functions

void createWorldDecal (GameWorld gameWorld, DecalBuilder builder)
 Create world decal from the stub information. More...
 
void failedLoading (String path, ResourceLoaderType resourceType)
 Resource has failed loading. More...
 
void finishedLoading (String path, ResourceLoaderType 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...
 
void loadResources ()
 Load resources. More...
 
StubWorldDecal new ()
 Create stub decal. More...
 
StubWorldDecal new (StubWorldDecal stub)
 Create copy of element stub. 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 Dragengine.Preloading.StubWithProperties
Dictionary getProperties ()
 Copy of all properties as dictionary mapping String key to String value. More...
 
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 (StubWithProperties stub)
 Create copy of stub with properties. More...
 
void readPropertiesFromFile (FileReader reader)
 Read properties from file. More...
 
void removeAllProperties ()
 Remove all properties. More...
 
void removePropertyWithKey (String key)
 Remove property if present. More...
 
void setFrom (Dictionary properties)
 Set all properties from dictionary mapping String key to String value. More...
 
void setFrom (StubWithProperties properties)
 Set properties from another StubWithProperties. More...
 
void setPropertyBoolFor (String key, bool value)
 Set property. More...
 
void setPropertyFloatFor (String key, float value)
 Set property. More...
 
void setPropertyIntFor (String key, int value)
 Set property. More...
 
void setPropertyValueFor (String key, String value)
 Set property. More...
 
void writePropertiesToFile (FileWriter writer)
 Write properties to file. More...
 
Notification

Additional Inherited Members

- Public Attributes inherited from Dragengine.Preloading.StubWithProperties
Dictionary pProperties
 Properties. More...
 

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 Dragengine.Preloading.StubWorldDecal.createWorldDecal ( GameWorld  gameWorld,
DecalBuilder  builder 
)

Create world decal from the stub information.

◆ failedLoading()

void Dragengine.Preloading.StubWorldDecal.failedLoading ( String  path,
ResourceLoaderType  resourceType 
)

Resource has failed loading.

Implements Dragengine.ResourceListener.

◆ finishedLoading()

void Dragengine.Preloading.StubWorldDecal.finishedLoading ( String  path,
ResourceLoaderType  resourceType,
Object  resource 
)

Resource has finished loading.

Implements Dragengine.ResourceListener.

◆ getColorTint()

Color Dragengine.Preloading.StubWorldDecal.getColorTint ( )

Color tint or null to not replace the color tint.

◆ getPathSkin()

String Dragengine.Preloading.StubWorldDecal.getPathSkin ( )

Skin path.

◆ getPosition()

DVector Dragengine.Preloading.StubWorldDecal.getPosition ( )

Position.

◆ getRotation()

Vector Dragengine.Preloading.StubWorldDecal.getRotation ( )

Rotation.

◆ getSize()

Vector Dragengine.Preloading.StubWorldDecal.getSize ( )

Size.

◆ getSkin()

Skin Dragengine.Preloading.StubWorldDecal.getSkin ( )

Skin.

◆ getTextureName()

String Dragengine.Preloading.StubWorldDecal.getTextureName ( )

Texture name.

◆ getTransform()

TexMatrix2 Dragengine.Preloading.StubWorldDecal.getTransform ( )

Texture coordinates transformation or null to not replace the transformation.

◆ getVisible()

bool Dragengine.Preloading.StubWorldDecal.getVisible ( )

Visiblity.

◆ loadResources()

void Dragengine.Preloading.StubWorldDecal.loadResources ( )

Load resources.

◆ new() [1/2]

StubWorldDecal Dragengine.Preloading.StubWorldDecal.new ( )

Create stub decal.

Reimplemented from Dragengine.Preloading.StubWithProperties.

◆ new() [2/2]

StubWorldDecal Dragengine.Preloading.StubWorldDecal.new ( StubWorldDecal  stub)

Create copy of element stub.

◆ preloadResources()

void Dragengine.Preloading.StubWorldDecal.preloadResources ( )

Add preload resources.

◆ setColorTint()

void Dragengine.Preloading.StubWorldDecal.setColorTint ( Color  color)

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

◆ setCounter()

void Dragengine.Preloading.StubWorldDecal.setCounter ( PreloadCounter  counter)

Set counter.

◆ setPathSkin()

void Dragengine.Preloading.StubWorldDecal.setPathSkin ( String  pathSkin)

Set skin path.

◆ setPosition()

void Dragengine.Preloading.StubWorldDecal.setPosition ( DVector  position)

Set position.

◆ setRotation()

void Dragengine.Preloading.StubWorldDecal.setRotation ( Vector  rotation)

Set rotation.

◆ setSize()

void Dragengine.Preloading.StubWorldDecal.setSize ( Vector  size)

Set size.

◆ setTextureName()

void Dragengine.Preloading.StubWorldDecal.setTextureName ( String  textureName)

Set texture name.

◆ setTransform()

void Dragengine.Preloading.StubWorldDecal.setTransform ( TexMatrix2  transform)

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

◆ setVisible()

void Dragengine.Preloading.StubWorldDecal.setVisible ( bool  visible)

Set visibility.

◆ verifyPreloading()

bool Dragengine.Preloading.StubWorldDecal.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: