kool-editor-model

0.18.0

kool-editor-model/de.fabmax.kool.editor.api/GameEntity

GameEntity

class GameEntity(val entityData: GameEntityData, val scene: EditorScene)

Constructors

constructor(entityData: GameEntityData, scene: EditorScene)

Types

sealed class InsertionPos

Properties

val children: List<GameEntity>

componentModCnt

var componentModCnt: Int

val components: List<GameEntityComponent>

var drawGroupId: Int

val entityData: GameEntityData

val GameEntity.globalToLocalD: Mat4d

val GameEntity.globalToLocalF: Mat4f

val id: EntityId

val GameEntity.isCreated: Boolean

val GameEntity.isDestroyed: Boolean

val GameEntity.isPrepared: Boolean

isPreparedOrRunning

val GameEntity.isPreparedOrRunning: Boolean

val GameEntity.isRunning: Boolean

val isSceneChild: Boolean

val isSceneRoot: Boolean

var isVisible: Boolean

var lifecycle: EntityLifecycle

val GameEntity.localToGlobalD: Mat4d

val GameEntity.localToGlobalF: Mat4f

val GameEntity.localToViewD: Mat4d

val GameEntity.localToViewF: Mat4f

var name: String

var parent: GameEntity?

val GameEntity.project: EditorProject

val requiredAssets: Set<AssetReference>

val scene: EditorScene

val GameEntity.sceneComponent: SceneComponent

val GameEntity.sceneEntity: GameEntity

val settings: GameEntitySettings

val settingsState: MutableStateValue<GameEntitySettings>

val transform: TransformComponent

val GameEntity.viewToLocalD: Mat4d

val GameEntity.viewToLocalF: Mat4f

Functions

fun addComponent(component: GameEntityComponent)

addComponentLifecycleAware

suspend fun addComponentLifecycleAware(component: GameEntityComponent)

applyComponents

suspend fun applyComponents()

cachedEntityComponents

inline fun <T : Any> GameEntity.cachedEntityComponents(): CachedEntityComponents<T>

cachedProjectComponents

inline fun <T : Any> GameEntity.cachedProjectComponents(): CachedProjectComponents<T>

cachedSceneComponents

inline fun <T : Any> GameEntity.cachedSceneComponents(): CachedSceneComponents<T>

createDataComponent

fun createDataComponent(info: ComponentInfo<*>): GameEntityDataComponent<*>

destroyComponents

fun destroyComponents()

inline fun <T : KoolBehavior> getBehavior(): T?

fun GameEntity.getBehavior(ref: BehaviorRef): KoolBehavior?

inline fun <T : Any> getComponent(): T?

fun GameEntity.getComponent(ref: ComponentRef): GameEntityComponent?

@JvmName(name = "getComponentsOfType")

inline fun <T : Any> getComponents(): List<T>

getOrPutComponent

inline fun <T : GameEntityComponent> getOrPutComponent(factory: () -> T): T

getOrPutComponentLifecycleAware

inline suspend fun <T : GameEntityComponent> getOrPutComponentLifecycleAware(factory: () -> T): T

inline fun <T : Any> hasComponent(): Boolean

onPhysicsUpdate

fun onPhysicsUpdate(timeStep: Float)

fun onUpdate(ev: RenderPass.UpdateEvent)

removeComponent

fun removeComponent(component: GameEntityComponent)

requireBehavior

inline fun <T : KoolBehavior> requireBehavior(): T

requireComponent

inline fun <T : Any> requireComponent(): T

fun setPersistent(settings: GameEntitySettings)

fun GameEntity.toGlobalCoords(vec: MutableVec3d, w: Double = 1.0): MutableVec3d

fun GameEntity.toGlobalCoords(vec: MutableVec3f, w: Float = 1.0f): MutableVec3f

fun GameEntity.toLocalCoords(vec: MutableVec3d, w: Double = 1.0): MutableVec3d

fun GameEntity.toLocalCoords(vec: MutableVec3f, w: Float = 1.0f): MutableVec3f