import Component from 'seed-engine/src/component/Component.js'

public class | source

Component

Updateable → Component

A component may be added to any GameObject by using GameObject's function: addComponent(component).

A component should redefine the Updateable functions inherited with custom code to define the Component functionality.

Constructor Summary

Public Constructor
public	constructor(unique: boolean) Constructor for Base Components.

Public Methods
public	onAddComponent() Called when the component is successfully added to a GameObject.

From class Updateable
public	deregister: *
public	hasPaused: boolean
public	hasStarted: boolean
public	id: *
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.

Constructor for Base Components. Requires a boolean to indicate if a GameObject can contain multiple components of this type.

Name	Type	Attribute	Description
unique	boolean		Is there only one of these component allowed on a GameObject?