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

Base class for stubs having properties. More...

Inheritance diagram for Dragengine.Preloading.StubWithProperties:
Dragengine.Preloading.StubElement Dragengine.Preloading.StubElementTexture Dragengine.Preloading.StubGameWorld Dragengine.Preloading.StubWorldDecal Dragengine.Preloading.StubElementClassNotFound

Public Member Functions

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 ()
 Create stub with properties. 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...
 

Public Attributes

Dictionary pProperties
 Properties. More...
 

Detailed Description

Base class for stubs having properties.

Member Function Documentation

◆ getProperties()

Dictionary Dragengine.Preloading.StubWithProperties.getProperties ( )

Copy of all properties as dictionary mapping String key to String value.

Version
1.22

◆ getPropertyBoolFor()

bool Dragengine.Preloading.StubWithProperties.getPropertyBoolFor ( String  key,
bool  default 
)

Boolean property value or default value if absent.

◆ getPropertyCount()

int Dragengine.Preloading.StubWithProperties.getPropertyCount ( )

Number of properties.

◆ getPropertyFloatFor()

float Dragengine.Preloading.StubWithProperties.getPropertyFloatFor ( String  key,
float  default 
)

Floating point property value or default value if absent.

◆ getPropertyIntFor()

int Dragengine.Preloading.StubWithProperties.getPropertyIntFor ( String  key,
int  default 
)

Integer property value or default value if absent.

◆ getPropertyKeys()

Array Dragengine.Preloading.StubWithProperties.getPropertyKeys ( )

Property keys (String array).

◆ getPropertyValueFor()

String Dragengine.Preloading.StubWithProperties.getPropertyValueFor ( String  key,
String  default 
)

Value of property or default value if absent.

◆ hasPropertyWithKey()

bool Dragengine.Preloading.StubWithProperties.hasPropertyWithKey ( String  key)

Property key is present.

◆ new() [1/2]

StubWithProperties Dragengine.Preloading.StubWithProperties.new ( )

Create stub with properties.

Reimplemented in Dragengine.Preloading.StubWorldDecal.

◆ new() [2/2]

StubWithProperties Dragengine.Preloading.StubWithProperties.new ( StubWithProperties  stub)

Create copy of stub with properties.

◆ readPropertiesFromFile()

void Dragengine.Preloading.StubWithProperties.readPropertiesFromFile ( FileReader  reader)

Read properties from file.

◆ removeAllProperties()

void Dragengine.Preloading.StubWithProperties.removeAllProperties ( )

Remove all properties.

◆ removePropertyWithKey()

void Dragengine.Preloading.StubWithProperties.removePropertyWithKey ( String  key)

Remove property if present.

◆ setFrom() [1/2]

void Dragengine.Preloading.StubWithProperties.setFrom ( Dictionary  properties)

Set all properties from dictionary mapping String key to String value.

Version
1.22

◆ setFrom() [2/2]

void Dragengine.Preloading.StubWithProperties.setFrom ( StubWithProperties  properties)

Set properties from another StubWithProperties.

◆ setPropertyBoolFor()

void Dragengine.Preloading.StubWithProperties.setPropertyBoolFor ( String  key,
bool  value 
)

Set property.

◆ setPropertyFloatFor()

void Dragengine.Preloading.StubWithProperties.setPropertyFloatFor ( String  key,
float  value 
)

Set property.

◆ setPropertyIntFor()

void Dragengine.Preloading.StubWithProperties.setPropertyIntFor ( String  key,
int  value 
)

Set property.

◆ setPropertyValueFor()

void Dragengine.Preloading.StubWithProperties.setPropertyValueFor ( String  key,
String  value 
)

Set property.

◆ writePropertiesToFile()

void Dragengine.Preloading.StubWithProperties.writePropertiesToFile ( FileWriter  writer)

Write properties to file.

Member Data Documentation

◆ pProperties

Dictionary Dragengine.Preloading.StubWithProperties.pProperties

Properties.


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