Class: ScriptComponent
The ScriptComponent allows you to extend the functionality of an Entity by attaching your own Script Types defined in JavaScript files to be executed with access to the Entity.
Properties
entity
entity: Entity
The Entity that this Component is attached to.
Inherited from
Component.entity
system
system: ComponentSystem
The ComponentSystem used to create this Component.
Inherited from
Component.system
enabled
Get Signature
get enabled(): boolean
Sets the enabled state of the component.
Returns
boolean
Set Signature
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
value
boolean
Returns
void
Overrides
Component.enabled
scripts
Get Signature
get scripts(): ScriptType[]
Gets the array of all script instances attached to an entity.
Returns
ScriptType
Set Signature
set scripts(value: ScriptType[]): void
Sets the array of all script instances attached to an entity. This array is read-only and should not be modified by developer.
Parameters
value
ScriptType
Returns
void
Methods
create()
create(nameOrType: string | typeof Script, args?: {
attributes: any;
enabled: boolean;
ind: number;
preloading: boolean;
properties: any;
}): null | ScriptType
Create a script instance and attach to an entity script component.
Parameters
nameOrType
The name or type of Script.
string | typeof Script
args?
Object with arguments for a script.
attributes?
any
Object with values for attributes (if any), where key is name of an attribute.
enabled?
boolean
If script instance is enabled after creation. Defaults to true.
ind?
number
The index where to insert the script instance at. Defaults to -1, which means append it at the end.
preloading?
boolean
If script instance is created during preload. If true, script and attributes must be initialized manually. Defaults to false.
properties?
any
Object with values that are assigned to the script instance.
Returns
null | ScriptType
Returns an instance of a ScriptType if successfully attached to an entity, or null if it failed because a script with a same name has already been added or if the ScriptType cannot be found by name in the ScriptRegistry.
Example
entity.script.create('playerController', {
attributes: {
speed: 4
}
})
destroy()
destroy(nameOrType: string | typeof ScriptType): boolean
Destroy the script instance that is attached to an entity.
Parameters
nameOrType
The name or type of ScriptType.
string | typeof ScriptType
Returns
boolean
If it was successfully destroyed.
Example
entity.script.destroy('playerController')
fire()
fire(
name: string,
arg1?: any,
arg2?: any,
arg3?: any,
arg4?: any,
arg5?: any,
arg6?: any,
arg7?: any,
arg8?: any): EventHandler
Fire an event, all additional arguments are passed on to the event listener.
Parameters
name
string
Name of event to fire.
arg1?
any
First argument that is passed to the event handler.
arg2?
any
Second argument that is passed to the event handler.
arg3?
any
Third argument that is passed to the event handler.
arg4?
any
Fourth argument that is passed to the event handler.
arg5?
any
Fifth argument that is passed to the event handler.
arg6?
any
Sixth argument that is passed to the event handler.
arg7?
any
Seventh argument that is passed to the event handler.
arg8?
any
Eighth argument that is passed to the event handler.
Returns
Self for chaining.
Example
obj.fire('test', 'This is the message')
Inherited from
Component.fire
get()
get(nameOrType: string | typeof ScriptType): null | ScriptType
Get a script instance (if attached).
Parameters
nameOrType
The name or type of ScriptType.
string | typeof ScriptType
Returns
null | ScriptType
If script is attached, the instance is returned. Otherwise null is returned.
Example
const controller = entity.script.get('playerController')
has()
has(nameOrType: string | typeof ScriptType): boolean
Detect if script is attached to an entity.
Parameters
nameOrType
The name or type of ScriptType.
string | typeof ScriptType
Returns
boolean
If script is attached to an entity.
Example
if (entity.script.has('playerController')) {
// entity has script
}
hasEvent()
hasEvent(name: string): boolean
Test if there are any handlers bound to an event name.
Parameters
name
string
The name of the event to test.
Returns
boolean
True if the object has handlers bound to the specified event name.
Example
obj.on('test', () => {}) // bind an event to 'test'
obj.hasEvent('test') // returns true
obj.hasEvent('hello') // returns false
Inherited from
Component.hasEvent
move()
move(nameOrType: string | typeof ScriptType, ind: number): boolean
Move script instance to different position to alter update order of scripts within entity.
Parameters
nameOrType
The name or type of ScriptType.
string | typeof ScriptType
ind
number
New position index.
Returns
boolean
If it was successfully moved.
Example
entity.script.move('playerController', 0)
off()
off(
name?: string,
callback?: HandleEventCallback,
scope?: any): EventHandler
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
Parameters
name?
string
Name of the event to unbind.
callback?
HandleEventCallback
Function to be unbound.
scope?
any
Scope that was used as the this when the event is fired.
Returns
Self for chaining.
Example
const handler = () => {}
obj.on('test', handler)
obj.off() // Removes all events
obj.off('test') // Removes all events called 'test'
obj.off('test', handler) // Removes all handler functions, called 'test'
obj.off('test', handler, this) // Removes all handler functions, called 'test' with scope this
Inherited from
Component.off
on()
on(
name: string,
callback: HandleEventCallback,
scope?: any): EventHandle
Attach an event handler to an event.
Parameters
name
string
Name of the event to bind the callback to.
callback
HandleEventCallback
Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope?
any = ...
Object to use as 'this' when the event is fired, defaults to current this.
Returns
Can be used for removing event in the future.
Examples
obj.on('test', (a, b) => {
console.log(a + b)
})
obj.fire('test', 1, 2) // prints 3 to the console
const evt = obj.on('test', (a, b) => {
console.log(a + b)
})
// some time later
evt.off()
Inherited from
Component.on
once()
once(
name: string,
callback: HandleEventCallback,
scope?: any): EventHandle
Attach an event handler to an event. This handler will be removed after being fired once.
Parameters
name
string
Name of the event to bind the callback to.
callback
HandleEventCallback
Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope?
any = ...
Object to use as 'this' when the event is fired, defaults to current this.
Returns
- can be used for removing event in the future.
Example
obj.once('test', (a, b) => {
console.log(a + b)
})
obj.fire('test', 1, 2) // prints 3 to the console
obj.fire('test', 1, 2) // not going to get handled
Inherited from
Component.once
Events
EVENT_CREATE
static EVENT_CREATE: string = 'create';
Fired when a ScriptType instance is created and attached to the script component. This event is available in two forms. They are as follows:
create- Fired when a script instance is created. The name of the script type and the script type instance are passed as arguments.create:[name]- Fired when a script instance is created that has the specified script type name. The script instance is passed as an argument to the handler.
Examples
entity.script.on('create', (name, scriptInstance) => {
console.log(`Instance of script '${'${name}'}' created`)
})
entity.script.on('create:player', (scriptInstance) => {
console.log(`Instance of script 'player' created`)
})
EVENT_DESTROY
static EVENT_DESTROY: string = 'destroy';
Fired when a ScriptType instance is destroyed and removed from the script component. This event is available in two forms. They are as follows:
destroy- Fired when a script instance is destroyed. The name of the script type and the script type instance are passed as arguments.destroy:[name]- Fired when a script instance is destroyed that has the specified script type name. The script instance is passed as an argument.
Examples
entity.script.on('destroy', (name, scriptInstance) => {
console.log(`Instance of script '${'${name}'}' destroyed`)
})
entity.script.on('destroy:player', (scriptInstance) => {
console.log(`Instance of script 'player' destroyed`)
})
EVENT_DISABLE
static EVENT_DISABLE: string = 'disable';
Fired when the script component becomes disabled. This event does not take into account the enabled state of the entity or any of its ancestors.
Example
entity.script.on('disable', () => {
console.log(
`Script component of entity '${'${entity.name}'}' has been disabled`
)
})
EVENT_ENABLE
static EVENT_ENABLE: string = 'enable';
Fired when the script component becomes enabled. This event does not take into account the enabled state of the entity or any of its ancestors.
Example
entity.script.on('enable', () => {
console.log(
`Script component of entity '${'${entity.name}'}' has been enabled`
)
})
EVENT_ERROR
static EVENT_ERROR: string = 'error';
Fired when a ScriptType instance had an exception. The handler is passed the script instance, the exception and the method name that the exception originated from.
Example
entity.script.on('error', (scriptInstance, exception, methodName) => {
console.log(`Script error: ${'${exception}'} in method '${'${methodName}'}'`)
})
EVENT_MOVE
static EVENT_MOVE: string = 'move';
Fired when the index of a ScriptType instance is changed in the script component. This event is available in two forms. They are as follows:
move- Fired when a script instance is moved. The name of the script type, the script type instance, the new index and the old index are passed as arguments.move:[name]- Fired when a specifically named script instance is moved. The script instance, the new index and the old index are passed as arguments.
Examples
entity.script.on('move', (name, scriptInstance, newIndex, oldIndex) => {
console.log(
`Script '${'${name}'}' moved from index '${'${oldIndex}'}' to '${'${newIndex}'}'`
)
})
entity.script.on('move:player', (scriptInstance, newIndex, oldIndex) => {
console.log(
`Script 'player' moved from index '${'${oldIndex}'}' to '${'${newIndex}'}'`
)
})
EVENT_REMOVE
static EVENT_REMOVE: string = 'remove';
Fired when the script component has been removed from its entity.
Example
entity.script.on('remove', () => {
console.log(`Script component removed from entity '${'${entity.name}'}'`)
})
EVENT_STATE
static EVENT_STATE: string = 'state';
Fired when the script component changes state to enabled or disabled. The handler is passed the new boolean enabled state of the script component. This event does not take into account the enabled state of the entity or any of its ancestors.
Example
entity.script.on('state', (enabled) => {
console.log(
`Script component of entity '${'${entity.name}'}' changed state to '${'${enabled}'}'`
)
})