Followable is a component that enables an entity to stay in front of another entity. Followable will track the orientation of the parent and move itself to stay in front.

Signature

class Followable(target: Entity = Entity.nullEntity(), offset: Pose = Pose(Vector3(0.0f, 0.0f, 3.0f), Quaternion(0.0f, 0.0f, 1.0f, 0.0f)), minAngle: Float = -90f, maxAngle: Float = 90.0f, type: FollowableType = FollowableType.FACE, tolerance: Float = 0.2f, speed: Float = 1.0f, active: Boolean = true) : ComponentBase

Constructors

Followable ( target , offset , minAngle , maxAngle , type , tolerance , speed , active )

Signature

constructor(target: Entity = Entity.nullEntity(), offset: Pose = Pose(Vector3(0.0f, 0.0f, 3.0f), Quaternion(0.0f, 0.0f, 1.0f, 0.0f)), minAngle: Float = -90f, maxAngle: Float = 90.0f, type: FollowableType = FollowableType.FACE, tolerance: Float = 0.2f, speed: Float = 1.0f, active: Boolean = true)

Parameters

target: Entity Target Entity to follow

offset: Pose Pose offset to keep from target. Defining a quaternion will rotate the Entity

minAngle: Float Minimum Y angle offset a followable will keep from target, 0 is straight ahead, positive values are up, negative values are down

maxAngle: Float Maximum Y angle offset a followable will keep from target, 0 is straight ahead, positive values are up, negative values are down

type: FollowableType The behavior an object has when following (faces user, pivots on y axis, etc.)

tolerance: Float This is the change in distance needed to start moving

speed: Float How fast followable tracks to its desired location. Float value is a percent of default speed

active: Boolean Whether entity is actively following or not

Returns

Followable

Properties

active : Boolean [Get][Set]	Whether entity is actively following or not Signature var active: Boolean
cachable : BuildConfig.COMPONENTCACHE_LEVEL >= 1 [Get][Set]	Signature open override var cachable: BuildConfig.COMPONENTCACHE_LEVEL >= 1
entID : Long [Get][Set]	Signature var entID: Long
isDirty : Boolean [Get][Set]	Signature var isDirty: Boolean
maxAngle : Float [Get][Set]	Maximum Y angle offset a followable will keep from target, 0 is straight ahead, positive values are up, negative values are down Signature var maxAngle: Float
minAngle : Float [Get][Set]	Minimum Y angle offset a followable will keep from target, 0 is straight ahead, positive values are up, negative values are down Signature var minAngle: Float
offset : Pose [Get][Set]	Pose offset to keep from target. Defining a quaternion will rotate the Entity Signature var offset: Pose
recycled : Boolean [Get][Set]	Signature var recycled: Boolean
speed : Float [Get][Set]	How fast followable tracks to its desired location. Float value is a percent of default speed Signature var speed: Float
target : Entity [Get][Set]	Target Entity to follow Signature var target: Entity
timeStamp : Long [Get][Set]	Signature var timeStamp: Long
tolerance : Float [Get][Set]	This is the change in distance needed to start moving Signature var tolerance: Float
type : FollowableType [Get][Set]	The type of behavior an object has when following (faces user, pivots on y axis, etc.) Signature var type: FollowableType

Methods

companion ()	Gets the companion object for this component. The companion object provides metadata about the component. Signature open override fun companion(): ComponentCompanion Returns `ComponentCompanion` The component's companion object Throws `RuntimeException` If the companion is not implemented
getComponentDataAttributeType ( key )	Gets the attribute type for the specified key. Signature fun getComponentDataAttributeType(key: Int): AttributePrimitive? Parameters `key: Int` The integer key to look up Returns `AttributePrimitive?` The attribute primitive type, or null if the key doesn't exist
getComponentDataAttributeType ( keyString )	Gets the attribute type for the specified string key. Signature fun getComponentDataAttributeType(keyString: String): AttributePrimitive? Parameters `keyString: String` The string key to look up Returns `AttributePrimitive?` The attribute primitive type Throws `IllegalArgumentException` If the key doesn't exist
getComponentDataKey ( key )	Gets the integer key associated with the specified string key. Signature fun getComponentDataKey(key: String): Int? Parameters `key: String` The string key to look up Returns `Int?` The integer key, or null if the string key doesn't exist
getComponentDataValue ( key )	Gets the value for the specified key. Signature fun getComponentDataValue(key: Int): Any? Parameters `key: Int` The integer key to look up Returns `Any?` The value associated with the key, or null if the key doesn't exist
getComponentDataValue ( keyString )	Gets the value for the specified string key. Signature fun getComponentDataValue(keyString: String): Any? Parameters `keyString: String` The string key to look up Returns `Any?` The value associated with the key, or null if the key doesn't exist Throws `IllegalArgumentException` If the key doesn't exist
getEnumClass ( key )	Gets the enum class associated with the specified string key. Signature fun getEnumClass(key: String): Class<out Enum<*>>? Parameters `key: String` The string key to look up Returns `Class?` The enum class, or null if the key doesn't exist or is not an enum
hasAttributeChanges ()	Returns true if any attribute has been modified since the last read/write sync. This is a read-only check. To clear the flag, call Entity.setComponent which syncs changes to native and resets the dirty state. Signature fun hasAttributeChanges(): Boolean Returns `Boolean`
hasComponentData ( key )	Checks if this component has data for the specified key. Signature fun hasComponentData(key: Int): Boolean Parameters `key: Int` The integer key to check Returns `Boolean` True if the component has data for the key, false otherwise
hasComponentData ( keyString )	Checks if this component has data for the specified string key. Signature fun hasComponentData(keyString: String): Boolean Parameters `keyString: String` The string key to check Returns `Boolean` True if the component has data for the key, false otherwise
read ( e , cachable )	Reads component data from the specified entity. Signature fun read(e: Entity, cachable: Boolean) Parameters `e: Entity` The entity to read data from `cachable: Boolean` Whether the component's data should be cached
recycle ()	Recycles this component by returning it to its pool. If the component has a pool assigned, it will be returned to that pool for reuse. Signature fun recycle()
reset ()	Resets the component to its default state. This method is called when a component is recycled to clear any state. Subclasses should override this method to reset their specific state. Signature open fun reset()
setComponentDataValue ( key , value )	Sets the value for the specified key. Signature fun setComponentDataValue(key: Int, value: Any): Boolean Parameters `key: Int` The integer key to set `value: Any` The value to set Returns `Boolean` True if the value was set successfully, false otherwise
setComponentDataValue ( keyString , value )	Sets the value for the specified string key. Signature fun setComponentDataValue(keyString: String, value: Any): Boolean Parameters `keyString: String` The string key to set `value: Any` The value to set Returns `Boolean` True if the key exists and the value was set, false otherwise
setPool ( pool , entID )	Sets the component pool and entity ID for this component. This is used for component recycling to track which pool the component belongs to and which entity it was associated with. Signature fun setPool(pool: ComponentPool<*>, entID: Long) Parameters `pool: ComponentPool` The component pool this component belongs to `entID: Long` The ID of the entity this component is associated with
toString ()	Signature open override fun toString(): String Returns `String`
typeID ()	Returns the unique type ID of this component. Each component type must have a unique ID for identification in the entity-component system. Signature open override fun typeID(): Int Returns `Int` The unique type ID for this component
write ( e )	Writes this component's data to the specified entity. Signature fun write(e: Entity) Parameters `e: Entity` The entity to write this component's data to

Companion Object

Properties

activeData : BooleanAttributeData [Get]	Signature val activeData: BooleanAttributeData
activeId : [Get]	Signature val activeId:
attributeKeys_ : IntArray [Get]	Signature val attributeKeys_: IntArray
attributeTypeCounts_ : IntArray [Get]	Signature val attributeTypeCounts_: IntArray
attributeTypes_ : IntArray [Get]	Signature val attributeTypes_: IntArray
attrMetaData_ : Map [Get]	Signature val attrMetaData_: Map
createDefaultInstance : Function0 [Get]	Signature open override val createDefaultInstance: () -> Followable
enumClassesMap_ : Map [Get]	Signature val enumClassesMap_: Map<Int, Class<out Enum<*>>>
id : [Get]	Signature open override val id:
keyStringToKeyIntMap_ : Map [Get]	Signature val keyStringToKeyIntMap_: Map<String, Int>
maxAngleData : FloatAttributeData [Get]	Signature val maxAngleData: FloatAttributeData
maxAngleId : [Get]	Signature val maxAngleId:
minAngleData : FloatAttributeData [Get]	Signature val minAngleData: FloatAttributeData
minAngleId : [Get]	Signature val minAngleId:
offsetData : PoseAttributeData [Get]	Signature val offsetData: PoseAttributeData
offsetId : [Get]	Signature val offsetId:
speedData : FloatAttributeData [Get]	Signature val speedData: FloatAttributeData
speedId : [Get]	Signature val speedId:
targetData : EntityAttributeData [Get]	Signature val targetData: EntityAttributeData
targetId : [Get]	Signature val targetId:
toleranceData : FloatAttributeData [Get]	Signature val toleranceData: FloatAttributeData
toleranceId : [Get]	Signature val toleranceId:
typeData : EnumAttributeData [Get]	Signature val typeData: EnumAttributeData
typeId : [Get]	Signature val typeId:

Methods

attributeKeys ()	Signature open override fun attributeKeys(): IntArray Returns `IntArray`
attributeMetaData ()	Returns `Map`
attributeTypeCountAvailable ()	Signature open override fun attributeTypeCountAvailable(): Boolean Returns `Boolean`
attributeTypeCounts ()	Signature open override fun attributeTypeCounts(): IntArray Returns `IntArray`
attributeTypes ()	Signature open override fun attributeTypes(): IntArray Returns `IntArray`
dependents ()	Signature open fun dependents(): IntArray Returns `IntArray`
enumClassesMap ()	Signature open override fun enumClassesMap(): Map<Int, Class<out Enum<*>>> Returns `Map`
keyStringToKeyIntMap ( keyString )	Signature open override fun keyStringToKeyIntMap(keyString: String): Int? Parameters `keyString: String` Returns `Int?`