Spot$Typings extension

on

• Spot

Properties

offsetX ↔ num

Available on Spot, provided by the Spot$Typings extension

Gets or sets the offsetX value of the Spot. The value may be negative. If this represents a side value instead of a specific spot, this value is meaningless.

getter/setter pair

offsetY ↔ num

Available on Spot, provided by the Spot$Typings extension

Gets or sets the offsetY value of the Spot. The value may be negative. If this represents a side value instead of a specific spot, this value is meaningless.

getter/setter pair

x ↔ num

Available on Spot, provided by the Spot$Typings extension

Gets or sets the x value of the Spot, a fractional value between zero and one.

getter/setter pair

y ↔ num

Available on Spot, provided by the Spot$Typings extension

Gets or sets the y value of the Spot, a fractional value between zero and one.

getter/setter pair

Methods

copy() → Spot

Available on Spot, provided by the Spot$Typings extension

Create a copy of this Spot, with the same values. @expose @return {Spot}

equals(Spot spot) → bool

Available on Spot, provided by the Spot$Typings extension

Two spots are equal if all four property values are the same. @param {Spot} spot The Spot to compare to the current Spot. @return {boolean} True if the two spots are equal, false otherwise.

includesSide(Spot side) → bool

Available on Spot, provided by the Spot$Typings extension

This predicate is true if this Spot is a side that includes the side(s) given by the argument Spot. @param {Spot} side @return {boolean} false if either this Spot or the argument Spot is not a "Side"; true if the side(s) that this Spot represents are a superset or the same set of sides represented by the argument Spot.

isDefault() → bool

Available on Spot, provided by the Spot$Typings extension

True if this is a special spot indicating that the real spot value will come from another source. @return {boolean}

isNone() → bool

Available on Spot, provided by the Spot$Typings extension

True if this is a special spot referring to no particular spot or side. @return {boolean}

isNoSpot() → bool

Available on Spot, provided by the Spot$Typings extension

True if this is an unspecific special spot, such as Spot.None or one of the sides. @return {boolean}

isSide() → bool

Available on Spot, provided by the Spot$Typings extension

True if this is a special spot referring to one (or more) of the sides. This is false if the spot is Spot.None. @return {boolean}

isSpot() → bool

Available on Spot, provided by the Spot$Typings extension

True if this is a specific spot, not a side nor Spot.None. @return {boolean}

opposite() → Spot

Available on Spot, provided by the Spot$Typings extension

Return a new spot that is opposite this spot. The X and Y values will be an equal distance away from the center on the other side of the center. The OffsetX and OffsetY values are also negated.

set(Spot s) → Spot

Available on Spot, provided by the Spot$Typings extension

Modify this Spot so that its X, Y, OffsetX, and OffsetY values are the same as the given Spot. @param {Spot} s the given Spot. @return {Spot} this.

setTo(num x, num y, num offx, num offy) → Spot

Available on Spot, provided by the Spot$Typings extension

Modify this Spot with new X, Y, OffsetX, and OffsetY values. @param {number} x @param {number} y @param {number} offx @param {number} offy @return {Spot} this.