gameforge - v0.1.12
    Preparing search index...

    Class ObservablePoint<T>

    The ObservablePoint object represents a location in a two-dimensional coordinate system, where x represents the position on the horizontal axis and y represents the position on the vertical axis.

    An ObservablePoint is a point that triggers a callback when the point's position is changed.

    PIXI

    Type Parameters

    • T = any

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    _x _y cb scope

    Accessors

    x y

    Methods

    clone copyFrom copyTo equals set

    Constructors

    • Creates a new ObservablePoint

      Type Parameters

      • T = any

      Parameters

      • cb: (this: T) => any

        callback function triggered when x and/or y are changed

      • scope: T

        owner of callback

      • Optionalx: number

        position of the point on the x axis

      • Optionaly: number

        position of the point on the y axis

      Returns ObservablePoint<T>

    Properties

    _x

    _x: number

    _y

    _y: number
    cb: (this: T) => any

    The callback function triggered when x and/or y are changed

    scope: any

    The owner of the callback

    Accessors

    • get x(): number

      Position of the observable point on the x axis.

      Returns number

    • set x(value: number): void

      Parameters

      • value: number

      Returns void

    • get y(): number

      Position of the observable point on the y axis.

      Returns number

    • set y(value: number): void

      Parameters

      • value: number

      Returns void

    Methods

    • Creates a clone of this point. The callback and scope params can be overridden otherwise they will default to the clone object's values.

      Parameters

      • Optionalcb: (this: T) => any

        The callback function triggered when x and/or y are changed

      • Optionalscope: any

        The owner of the callback

      Returns ObservablePoint

      a copy of this observable point

    • Copies x and y from the given point (p)

      Parameters

      • p: IPointData

        The point to copy from. Can be any of type that is or extends IPointData

      Returns this

      The observable point instance itself

    • Copies this point's x and y into that of the given point (p)

      Type Parameters

      Parameters

      • p: T

        The point to copy to. Can be any of type that is or extends IPointData

      Returns T

      The point (p) with values updated

    • Accepts another point (p) and returns true if the given point is equal to this point

      Parameters

      Returns boolean

      Returns true if both x and y are equal

    • Sets the point to a new x and y position. If y is omitted, both x and y will be set to x.

      Parameters

      • Optionalx: number

        position of the point on the x axis

      • Optionaly: number

        position of the point on the y axis

      Returns this

      The observable point instance itself

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods