Actor

class Actor(parent: ActorParent) : ActorParent

An Actor represents every item you see within the game, and is arguably the most important Kyd class,

Even static scenery are Actors.

You may argue that Actor is a bad name for scenery, but it makes me smile as it reminds me of a scene in "A Midsummer Night's Dream". There is a play within a play, and one of the actors takes on the role of a wall. In the original :

_Bottom_ : let him hold his fingers thus, and through that cranny shall _Pyramus_ and _Thisbe_ whisper.

However, in the version I saw, Wall was played by a petite young actress in a leotard, and an entirely different cranny was chosen. While kneeling down Pyramus couldn't be heard by Thisbe, so Wall suggests Pyramus widen the cranny with his fingers. The look on Pyramus' face was priceless. Shakespeare plays are often smutty, but they took it to another level. If you are ever in London, take in a comedy at The Globe - cheap a chips and funny as hell.

Constructors

Actor

constructor(parent: ActorParent)

Properties

angleDegrees

var angleDegrees: Float

angleDegreesProperty

val angleDegreesProperty: FloatProperty

The angle of rotation about position point (measured in degrees). Positive angles are anticlockwise, i.e. PI/2 radians will rotate a quart-turn anticlockwise.

angleRadians

var angleRadians: Float

The angle of rotation about position point (measured in radians). Positive angles are anticlockwise, i.e. PI/2 radians will rotate a quart-turn anticlockwise.

appearance

var appearance: Appearance

appearanceProperty

val appearanceProperty: SimpleProperty<Appearance>

behaviour

var behaviour: Behaviour

behaviourProperty

val behaviourProperty: SimpleProperty<Behaviour>

behaviourType

var behaviourType: String

behaviourTypeProperty

val behaviourTypeProperty: StringProperty

TODO This won't be needed when the editor dynamically loads the game's jar files. Without this, behaviours will reset to NoRole when an act is saved.

children

open override val children: MutableObservableList<Actor>

var id: String

idProperty

val idProperty: StringProperty

If you wish to find an actor by its id. There is no guarantee of uniqueness. Kyd itself doesn't use this field, it exists only because it might be useful. toString includes the id, which may help debugging.

isBelow

var isBelow: Boolean

isBelowProperty

val isBelowProperty: BooleanProperty

When this Actor is a child (rather than being part of a Stage), should it be drawn BELOW its parent?

localToWorld

val localToWorld: Matrix

localToWorldProperty

val localToWorldProperty: ObservableValue<Matrix>

A transformation matrix used while drawing.

parent

var parent: ActorParent

position

var position: Vector2

positionProperty

val positionProperty: Vector2Property

The position of the actor relative to its parent. For a top-level actor (whose parent is a Stage), this uses CoordinateSystem.world. But if this is a child of another Actor, the position is relative to the parent Actor (See CoordinateSystem.child).

role

var role: Role?

roleProperty

val roleProperty: SimpleProperty<Role?>

scale

var scale: Vector2

scaleProperty

val scaleProperty: Vector2Property

scaleX

var scaleX: Float

A convenient alternative to get/set scale.x

scaleXY

var scaleXY: Float

A convenient way to set the x and y values of scale. If you read the value, it returns the x component of scale.

scaleY

var scaleY: Float

A convenient alternative to get/set scale.y

userData

var userData: Any?

Additional data used by the editor. Never used during game-play.

visible

var visible: Boolean

visibleProperty

val visibleProperty: BooleanProperty

Hides the actor without changing its appearance.

worldToLocal

val worldToLocal: Matrix

worldToLocalProperty

val worldToLocalProperty: ObservableValue<Matrix>

var x: Float

A convenient alternative to get/set position.x

var y: Float

A convenient alternative to get/set position.y

zOrder

var zOrder: Float

zOrderProperty

val zOrderProperty: FloatProperty

Only used when placed on a ZOrderStage. It is often better to create separate Stages, rather than using zOrder. For example, if you have terrain, walking and flying objects, create 3 stages. When you do this, the zOrder is often not relevant.

Functions

addActor

open override fun addActor(actor: Actor)

colorAtWorldPoint

fun colorAtWorldPoint(worldPoint: Vector2): Color

Returns our color at a given worldPoint. If the point is outside our bounds, it will always be Color.TRANSPARENT. This is used to test if a mouse event is touching this actor, by comparing the color's alpha with a threshold value.

removeActor

open override fun removeActor(actor: Actor)

toString

open override fun toString(): String