Skip to content

Actor

The Actor component is used to associate a sprite to a target object. The target object is required to be an entity. It's recommended to use only one actor per entity.

Factory

Actor

Actor(sprite)

Spawns a new Actor component with the given sprite name.

Arguments

  • sprite: string. The name of the sprite (defined in the sprites/ folder).

Returns

An Actor component.

Example 

using SurgeEngine.Actor;

object "SurgeTest" is "entity"
{
    // spawns an Actor with the SurgeTest sprite
    actor = Actor("SurgeTest");

    state "main"
    {
    }
}

Properties

anim

anim: number.

A shortcut to animation.id: an integer corresponding to the animation number. Defaults to 0.

animation

animation: Animation object, read-only.

Reference to the Animation object of the Actor.

entity

entity: object, read-only.

The entity associated with this component.

hflip

hflip: boolean.

Should the actor be flipped horizontally? Defaults to false.

vflip

vflip: boolean.

Should the actor be flipped vertically? Defaults to false.

visible

visible: boolean.

Should the actor be rendered? Defaults to true.

alpha

alpha: number.

Opacity value, ranging from zero (0% opaque) to one (100% opaque). Defaults to 1.0.

offset

offset: Vector2 object.

A (x,y) offset relative to the parent object. Defaults to zero.

anchor

anchor: Vector2 object.

A shortcut to animation.anchor. See also: anchor.

Available since: Open Surge 0.6.0

hotSpot

hotSpot: Vector2 object.

A shortcut to animation.hotSpot. See also: hot spot.

Available since: Open Surge 0.6.0. In versions prior to 0.6.0, you may get the hot spot using the Animation object.

actionSpot

actionSpot: Vector2 object.

A shortcut to animation.actionSpot. See also: action spot.

Available since: Open Surge 0.6.0

actionOffset

actionOffset: Vector2 object, read-only.

A shortcut to animation.actionOffset. See also: action offset.

Available since: Open Surge 0.6.0

width

width: number, read-only.

The width of the actor.

height

height: number, read-only.

The height of the actor.

zindex

zindex: number.

Objects with greater zindex are rendered in front of others. Defaults to 0.5.