API reference
API reference
Select your platform
No SDKs available
No versions available

PanelDimensions

PanelDimensions

class PanelDimensions(dimensions: Vector2 = Vector2(1.0f * 3f / 4f, 1.0f)) : ComponentBase
PanelDimensions is a component that holds the dimensions of a panel. This is used to override the height and width of a panel when creating the panel. Without it, the panel’s height and width will be the values from @see PanelRegistration.
Parameters
JVM
NameSummary
dimensions
The dimensions of the panel.

Constructors

NameSummary
PanelDimensions
constructor(dimensions: Vector2 = Vector2(1.0f * 3f / 4f, 1.0f))

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
dimensions
var dimensions: Vector2
The dimensions of the panel.
isDirty
var isDirty: Boolean
recycled
var recycled: Boolean

Functions

NameSummary
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributeType?
fun getComponentDataAttributeType(keyString: String): AttributeType?
getComponentDataKey
fun getComponentDataKey(key: String): Int?
getComponentDataValue
fun getComponentDataValue(key: Int): Any?
fun getComponentDataValue(keyString: String): Any?
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?
hasComponentData
fun hasComponentData(key: Int): Boolean
fun hasComponentData(keyString: String): Boolean
read
fun read(e: Entity, cachable: Boolean)
recycle
fun recycle()
reset
open fun reset()
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any?): Boolean
fun setComponentDataValue(keyString: String, value: Any?): Boolean
setPool
fun setPool(pool: ComponentPool<*>)
toString
open override fun toString(): String
typeID
open override fun typeID(): Int
write
fun write(e: Entity)

Companion

object Companion : ComponentCompanion

Properties

NameSummary
createDefaultInstance
open override val createDefaultInstance: () -> PanelDimensions
id
open override val id: <Error class: unknown class>

Functions

NameSummary
dependents
open fun dependents(): IntArray
Did you find this page helpful?
Thumbs up icon
Thumbs down icon