Use this Component to hide an Entity from every user except for the creator of the Entity or hide the entity from only the creator. This MUST be used with dynamically created Entities, Entities created using scene.xml do not have a "creator" and so will not be hidden.

This Component is currently only designed for simple use like having an object or panel that only the creator can see. If you need more complex visibility logic you will need to write your own Visibility Component and System, feel free to use this one as a reference.

Parameters

JVM

Name	Summary
state	The state of the visibility, see CreatorVisibilityState for more info

Constructors

Name	Summary
CreatorVisibility	constructor(state: CreatorVisibilityState = CreatorVisibilityState.CREATOR_ONLY_VISIBLE)

Types

Name	Summary
Companion	object Companion : ComponentCompanion

Properties

Name	Summary
cachable	open val cachable: Boolean = false
creationTime	var creationTime: Long
isDirty	var isDirty: Boolean
recycled	var recycled: Boolean
state	var state: CreatorVisibilityState Different states of CreatorVisibility, such as only visible to the creator, or only invisible to the creator

Functions

Name	Summary
getComponentDataAttributeType	fun getComponentDataAttributeType(key: Int): AttributePrimitive? fun getComponentDataAttributeType(keyString: String): AttributePrimitive?
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

Name	Summary
createDefaultInstance	open override val createDefaultInstance: () -> CreatorVisibility
id	open override val id: <Error class: unknown class>
stateId	val stateId: <Error class: unknown class>

Functions

Name	Summary
dependents	open fun dependents(): IntArray