Class: RenderSystem
RenderSystem is an abstract class representing a generic rendering system, has logic for handling loading renderables. Contains the message constant for loading renderables.
Hierarchy
-
↳ RenderSystem
↳↳ WebGLSystem
Table of contents
Constructors
Properties
- entities
- messageBus
- renderables
- scene
- subscriberID
- MESSAGE_DEREGISTER
- MESSAGE_LOAD_RENDERABLES
- MESSAGE_REGISTER
- MESSAGE_UPDATE
Methods
Constructors
constructor
+ new RenderSystem(messageBus
: IMessageBus, scene?
: IScene, evaluator?
: Evaluator, renderables?
: IRenderable[], entities?
: SystemEntity[], subscriberID?
: number): RenderSystem
Parameters:
Name | Type |
---|---|
messageBus |
IMessageBus |
scene? |
IScene |
evaluator? |
Evaluator |
renderables |
IRenderable[] |
entities? |
SystemEntity[] |
subscriberID? |
number |
Returns: RenderSystem
Inherited from: ArraySystem
Properties
entities
• Protected
entities: SystemEntity[]
The list of entities the system is tracking.
Inherited from: ArraySystem.entities
messageBus
• Protected
messageBus: IMessageBus
Reference to the message bus, the fundamental piece of JamJar for communicating with other parts of the engine.
Inherited from: ArraySystem.messageBus
renderables
• Protected
renderables: IRenderable[]
A list of things to be rendered.
scene
• Protected
Optional
scene: undefined | IScene
Any scene this system is part of, will change the lifecycle of the system to be part of the scene's lifecycle - it will be destroyed when the scene is destroyed.
Inherited from: ArraySystem.scene
subscriberID
• subscriberID: number
Inherited from: ArraySystem.subscriberID
MESSAGE_DEREGISTER
▪ Readonly
Static
MESSAGE_DEREGISTER: stateful_system_deregister= "stateful_system_deregister"
Message to deregister an entity + components with a system so it is no longer tracked.
Inherited from: ArraySystem.MESSAGE_DEREGISTER
MESSAGE_LOAD_RENDERABLES
▪ Readonly
Static
MESSAGE_LOAD_RENDERABLES: load_renderables= "load_renderables"
Message used to add new renderables into the render system's render list.
MESSAGE_REGISTER
▪ Readonly
Static
MESSAGE_REGISTER: stateful_system_register= "stateful_system_register"
Message to register an entity + components with a system so it can be tracked.
Inherited from: ArraySystem.MESSAGE_REGISTER
MESSAGE_UPDATE
▪ Readonly
Static
MESSAGE_UPDATE: system_update= "system_update"
Inherited from: ArraySystem.MESSAGE_UPDATE
Methods
Destroy
▸ Destroy(): void
Destroy destroys the System and unsubscribes it from all messages. The System should be garbage collected after this, unless a direct reference to it exists somewhere. Therefore direct references to systems are discouraged; communication should all be through the message bus.
Returns: void
Inherited from: ArraySystem
OnDestroy
▸ Protected
OnDestroy(): void
Custom Destroy logic should go here to facilitate garbage collection, for example removing listeners.
Returns: void
Inherited from: ArraySystem
OnMessage
▸ OnMessage(message
: IMessage): void
Parameters:
Name | Type |
---|---|
message |
IMessage |
Returns: void
Overrides: ArraySystem
Update
▸ Protected
Update(dt
: number): void
General update method, default empty. Override with custom logic.
Parameters:
Name | Type | Description |
---|---|---|
dt |
number | DeltaTime |
Returns: void
Inherited from: ArraySystem
register
▸ Protected
register(entity
: IEntity, components
: Component[]): void
Parameters:
Name | Type |
---|---|
entity |
IEntity |
components |
Component[] |
Returns: void
Inherited from: ArraySystem
remove
▸ Protected
remove(entity
: IEntity): void
Parameters:
Name | Type |
---|---|
entity |
IEntity |
Returns: void
Inherited from: ArraySystem