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

Panel

Panel

class Panel(panelRegistrationId: Int = 0, hittable: MeshCollision = MeshCollision.LineTest) : ComponentBase
Panel is a component that can be attached to a scene object to indicate that it is a panel.
Parameters
JVM
NameSummary
panelRegistrationId
The id of the panel. This is used to identify the @PanelRegistration when creating the panel.
hittable
hit test type for the panel, @see MeshCollision

Constructors

NameSummary
Panel
constructor(panelRegistrationId: Int = 0, hittable: MeshCollision = MeshCollision.LineTest)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
hittable
var hittable: MeshCollision
isDirty
var isDirty: Boolean
panelRegistrationId
var panelRegistrationId: Int
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: () -> Panel
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