Engine::actor: Difference between revisions

This namespace houses [[ModuleSystem]]'s Actor system. Treat names as unofficial unless otherwise stated.

 

 

Houses a set of user callbacks for the actor system. Manages the ActorInstanceHeap which is by default responsible for most IActor and PreActor memory management. Maintains an array of factories for creating IActor class derivatives by name.

=== IActor ===

This is the base interface of an actor that can be scheduled in the actor system. Each IActor has a heap meant for all of it's memory management, a unique id, the name of it's actor settings, a user defined name, it's current state, a set of request slots for requesting changes to it's state. A set of job slots for all 32 stage and priority combinations in the actor scheduler, with an extra sleep job slot. A tree map node for the ActorMgr. A reference to a structure used to manage the state for "hyperlinks" to an actor. A reference to a watcher for signifying state changes during asynchronous creation. A ring of references to the actor's relationships.

ActorBase extends IActor by implementing a job for each of the 4 calc stages provided by the ActorMgr's scheduler. These calc stages are named PreCalc, PostCalc, PostSensor, and FrameEndCalc. Notably, FrameStartCalc happens directly before PreCalc in the PreCalc job. ActorBase maintains a home transform, a current transform, a request for the next transform, angular and linear velocites, an AABB, a Document reference to it's ActorParam, a reference to it's PreActor, a Transceiver, a BlackboardAccessor, an ActorBaseLink to an optional linked actor, and a pause key allocator for maintaining a pause mask for calculate stages of the actor that can be individually paused. The majority of ActorBase behavior is implemented in a set of engine provided optional components (See [[Engine::component#IActorComponent|engine::component]]).