import Updateable from 'seed-engine/src/base/Updateable.js'

public class | source

Updateable

Direct Subclass:

Component, GameObject, Scene, Viewport

Baseclass for objects that follow the same ECS pattern of the seed engine.

Used in anything that should follow a create, update, end loop handled by the Engine.

Many things will need to update/start/end. If you derive something that has the start()/update()/end()... functions, the children should fill in their respective callbacks (onStart()/onUpdate()/onEnd()/...).

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	deregister: *
public	hasPaused: boolean
public	hasStarted: boolean
public	id: *

Method Summary

Public Methods
public	destructor() Cleanup code for when destroying an Updateable.
public	end() Base call function for when this Updateable is to be ended.
public	onEnd() Called when the object is being removed or cleaned up from usage.
public	onPause() Called when the object is intended to be paused.
public	onStart() Called when the the object is first introduced.
public	onUnpause() Called when the object is to be unpaused from paused state.
public	onUpdate() Called on every update within the game, once the object has had onStart called.
public	pause() Base call function for when this Updateable is to be paused.
public	start() Base call function for when this Updateable is to be started.
public	unpause() Base call function for when this Updateable is to be unpaused.
public	update() Base call function for when this Updateable is to be updated.

Public Constructors

public constructor() source

Public Members

public deregister: * source

public hasPaused: boolean source

public hasStarted: boolean source

public id: * source

Public Methods

public destructor() source

Cleanup code for when destroying an Updateable.

public end() source

Base call function for when this Updateable is to be ended.

public onEnd() source

Called when the object is being removed or cleaned up from usage.

public onPause() source

Called when the object is intended to be paused.

public onStart() source

Called when the the object is first introduced.

Managing code will call this on first iteration once introduced to the game loop.

public onUnpause() source

Called when the object is to be unpaused from paused state.

public onUpdate() source

Called on every update within the game, once the object has had onStart called.

public pause() source

Base call function for when this Updateable is to be paused.

public start() source

Base call function for when this Updateable is to be started.

public unpause() source

Base call function for when this Updateable is to be unpaused.

public update() source

Base call function for when this Updateable is to be updated.