Constructor#
new Actor(pos, rotation, scale, collision, sprite, persistent, events, components, id)#
Create a new actor.
Parameters:
| Name | Type | Description |
|---|---|---|
pos | Vec2 | Initial position in space |
rotation | number | Rotation around center |
scale | number | Uniform scaling for rendering |
collision | "auto" | | Collision initializer |
sprite | Sprite | | Sprite or sprite identifier for rendering |
persistent | boolean | Whether to always update regardless of loaded chunks |
events | Object.<string, (function()|Array.<function()>)> | Events to register |
components | Object.<string, ActorComponent> | Components to add |
id | string | Global (in space) identifier of actor |
- Source
Members#
collisionBounds#
Get the total bounding box of all collision components.
- Source
components#
Get the component manager.
- Source
drawableBounds#
Get the total bounding box of all drawable components.
- Source
globalID#
Get the global identifier.
- Source
globalID#
Set the global (space) identifier.
- Source
globalPos#
Get the global position.
- Source
globalPos#
Set the global (absolute) position.
- Source
initialized#
Check if the actor has been initialized.
- Source
pos#
Get the local position.
- Source
pos#
Set the local (relative) position.
- Source
Methods#
addAnimation(animation) → {ActorAnimation}#
Add an animation.
Parameters:
| Name | Type | Description |
|---|---|---|
animation | ActorAnimation | Animation to add |
- Source
Returns:
Animation that was added
- Type:
- ActorAnimation
checkCollision(other, pos) → {Object}#
Check collision with another actor.
Parameters:
| Name | Type | Description |
|---|---|---|
other | CollisionComponent | Other component to check with |
pos | Vec2 | The position to attempt to move to |
- Source
Returns:
Collision result
- Type:
- Object
clearChildren()#
Remove and delete all child actors.
- Source
clearOverlappingChunks()#
Clear and remove actor from all overlapping chunks.
- Source
delete()#
Mark the actor for deletion.
- Source
doEvent(event, …args)#
Run all functions attached to a specified event.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event | ActorEvent | | Event to trigger | |
args | any | <repeatable> | Arguments to pass into functions |
- Source
draw(ctx)#
Draw the actor
Parameters:
| Name | Type | Description |
|---|---|---|
ctx | CanvasRenderingContext2D | The canvas context to draw on |
- Source
drawDebug(ctx, showID, showDot)#
Draw debug information for the actor (if enabled).
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
ctx | CanvasRenderingContext2D | Canvas context to draw on | |
showID | boolean | true | Whether to show chunk actor ID |
showDot | boolean | true | Whether to show the dot in the center |
- Source
findOverlappingChunks()#
Find, save, and register in all chunks that collision components are overlapping with.
- Source
forEachChild(func)#
Run a function for each child actor.
Parameters:
| Name | Type | Description |
|---|---|---|
func | function | Function to run for each child |
- Source
getTransformMatrix(trans, rot, scale)#
Get the global transformation matrix.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
trans | boolean | true | Whether to include translation |
rot | boolean | true | Whether to include rotation |
scale | boolean | true | Whether to include scaling |
- Source
Returns:
Global transformation matrix
hasAnimations() → {boolean}#
Check if there are any active animations.
- Source
Returns:
Whether any animations are active
- Type:
- boolean
hasParent() → {boolean}#
Check if the actor has a parent actor.
- Source
Returns:
Whether actor has a parent
- Type:
- boolean
init()#
Executed when an actor is added to a space.
- Source
on(event, func)#
Add an event function.
Parameters:
| Name | Type | Description |
|---|---|---|
event | ActorEvent | | Event to add function to |
func | function | Function to run when called |
- Source
removeChild(actor)#
Remove a child actor. This will delete the actor.
Parameters:
| Name | Type | Description |
|---|---|---|
actor | Actor | Child to remove |
- Source
resetShadow(ctx)#
Reset/remove the shadow for drawing.
Parameters:
| Name | Type | Description |
|---|---|---|
ctx | CanvasRenderingContext2D | Canvas context to draw on |
- Source
setParent(actor)#
Set the parent actor (do not call this manually).
Parameters:
| Name | Type | Description |
|---|---|---|
actor | Actor | New parent actor. |
- Source
setShadow(ctx)#
Set up the shadow for drawing.
Parameters:
| Name | Type | Description |
|---|---|---|
ctx | CanvasRenderingContext2D | Canvas context to draw on |
- Source
stopAnimations()#
Stop all animations.
- Source
update(elapsed)#
Update the actor
Parameters:
| Name | Type | Description |
|---|---|---|
elapsed | number | Time since last update |
- Source
Type Definitions#
addChild#
Add a child actor.
Type:
- Source