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

Border size value element class property for use with XML loading. More...

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

Public Member Functions

void copyValue (ElementClass elementClass, ElementClassProperty property)
 Copy value from another element class property of the same type. More...
 
BorderSize getBorderSize ()
 Value. More...
 
BorderSize getBorderSize (StubWithProperties stub, CodecPropertyString codec)
 Border size modified by stub property if present. More...
 
ECPBorderSize new (String name, BorderSize value)
 Create property. More...
 
void setBorderSize (BorderSize area)
 Set value. 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

Border size value element class property for use with XML loading.

Member Function Documentation

◆ copyValue()

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

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

Version
1.17

◆ getBorderSize() [1/2]

BorderSize Dragengine.Scenery.ECPBorderSize.getBorderSize ( )

Value.

◆ getBorderSize() [2/2]

BorderSize Dragengine.Scenery.ECPBorderSize.getBorderSize ( StubWithProperties  stub,
CodecPropertyString  codec 
)

Border size modified by stub property if present.

If named stub property is not present or empty string the stored border size is returned. If the named stub property is present it is decoded using codec.

The following property value formats are understood where "size", "left", "top", "right" and "bottom" are positive integer values including 0:

  • "size": BorderSize.new(size)
  • "left top right bottom": BorderSize.new(left, top, right, bottom)

◆ new()

ECPBorderSize Dragengine.Scenery.ECPBorderSize.new ( String  name,
BorderSize  value 
)

Create property.

◆ setBorderSize()

void Dragengine.Scenery.ECPBorderSize.setBorderSize ( BorderSize  area)

Set value.

◆ setValue()

void Dragengine.Scenery.ECPBorderSize.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: