Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECPShapeList Class Reference

Shape list element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPShapeList:
Dragengine.Scenery.ElementClassProperty

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
CodecPropertyString getCodec ()
 Coded used to decode shape string. More...
 
ShapeList getShapeList ()
 Shape list. More...
 
ShapeList getShapeList (StubWithProperties stub)
 Shape list modified by stub property if present. More...
 
ShapeList getShapeList (StubWithProperties stub, String name)
 Shape list modified by stub property if present. More...
 
String getShapeListString ()
 Shape list string. More...
 
ECPShapeList new (String name, CodecPropertyString codec)
 Create property. More...
 
ECPShapeList new (String name, CodecPropertyString codec, ShapeList shapeList)
 Create property with initial path. More...
 
void setShapeList (ShapeList shape)
 Set shape. More...
 
void setShapeListFromString (String string)
 Set shape list from shape string. More...
 
void setValue (Object value)
 Set value of property from XML decoded value. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void dispose ()
 Dispose of element class property to break reference loops. More...
 
String getName ()
 Name. More...
 
bool logPreloadProblems (ElementClass elementClass, Console console)
 Log preloading problems. More...
 
ElementClassProperty new (String name)
 Create property. More...
 
void preloadResources (ElementClass elementClass, PreloadCounter counter)
 Preload resources if supported. More...
 

Detailed Description

Shape list element class property for use with XML loading.

Shape list is stored as ShapeList instance. From XML the shape list is read using an encoded string decoded using CodecPropertyString.

Member Function Documentation

◆ copyValue()

void Dragengine.Scenery.ECPShapeList.copyValue ( ElementClass  elementClass,
ElementClassProperty  property 
)

Copy value from another element class property of the same type.

Version
1.17

◆ getCodec()

CodecPropertyString Dragengine.Scenery.ECPShapeList.getCodec ( )

Coded used to decode shape string.

◆ getShapeList() [1/3]

ShapeList Dragengine.Scenery.ECPShapeList.getShapeList ( )

Shape list.

◆ getShapeList() [2/3]

ShapeList Dragengine.Scenery.ECPShapeList.getShapeList ( StubWithProperties  stub)

Shape list modified by stub property if present.

If named stub property is not present the stored shape list is returned. If the named stub property is present it is decoded using the stored decoder and the result returned.

Uses the stored property name as stub property name.

◆ getShapeList() [3/3]

ShapeList Dragengine.Scenery.ECPShapeList.getShapeList ( StubWithProperties  stub,
String  name 
)

Shape list modified by stub property if present.

If named stub property is not present the stored shape list is returned. If the named stub property is present it is decoded using the stored decoder and the result returned.

◆ getShapeListString()

String Dragengine.Scenery.ECPShapeList.getShapeListString ( )

Shape list string.

◆ new() [1/2]

ECPShapeList Dragengine.Scenery.ECPShapeList.new ( String  name,
CodecPropertyString  codec 
)

Create property.

◆ new() [2/2]

ECPShapeList Dragengine.Scenery.ECPShapeList.new ( String  name,
CodecPropertyString  codec,
ShapeList  shapeList 
)

Create property with initial path.

◆ setShapeList()

void Dragengine.Scenery.ECPShapeList.setShapeList ( ShapeList  shape)

Set shape.

◆ setShapeListFromString()

void Dragengine.Scenery.ECPShapeList.setShapeListFromString ( String  string)

Set shape list from shape string.

◆ setValue()

void Dragengine.Scenery.ECPShapeList.setValue ( Object  value)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.


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