Class GameObject

Classdesc

Base class for all objects in the scene

Example

 const gameObject = new GameObject({
     physicsEnabled: true,
     physicsOptions: {
         restitution: 0.5
    }
 });

Example

 const gameObject = new GameObject();

Hierarchy (view full)

GameObject

Indexable

[key: string]: any

Constructors

constructor

new GameObject(options?): GameObject
Parameters
- options: GameObjectOptions = {}
  GameObjectOptions to initialize the object with
Returns GameObject
- Defined in index.ts:1265

Properties

_state

_state: {
[key: string]: any;
}

used for state() and returnState(), builds states that are returnable. Stacking two states is destructive.

Type declaration

[key: string]: any

blockedBy

blockedBy: GameObject[]

List of objects that block this object

blocks

blocks: GameObject[]

List of objects that this object blocks

body

body: any

reference to the physics body (matter.js). Empty if physics is not enabled

bounds

bounds: number[]

how the object is bounded in the scene (set with scene.setBoundaries())

boundsActive

boundsActive: boolean

are the bounds active on this object?

convex

convex: boolean

true if the object is convex, false otherwise

coordinates

coordinates: Vec2

coordinates of the object, or the top left most point of the object

gameObjectOptions

gameObjectOptions: GameObjectOptions

Game object options of the game object (for serialization and recreation)

hitbox

hitbox: Vec2

Hitbox of the object, if the object is a square

id

id: string

unique ID for each object

isLocalPlayer

isLocalPlayer: boolean

True if the object is the local player, false otherwise

physicsEnabled

physicsEnabled: boolean

boolean if physics is enabled on the object

physicsOptions

physicsOptions: PhysicsOptions

options for the physics engine

pinRef

pinRef: "center" | "coordinates"

Reference point to pin the object to (only applies if the object is pinned)

pinned

pinned: null | GameObject

does nothing!

points

points: Vec2[]

points of the object (used for collision detection)

square

square: boolean

True if the object is a square, false otherwise

type

type: string

Type of the object, either "gameObject", "sprite", or "polygon"

Methods

activateBounds

activateBounds(): void
Activates bounds on that object

Returns void
- Defined in index.ts:1482

applyForce

applyForce(vector): void
Applies a force to the object (only works if physics enabled)
Parameters
- vector: Vec2
  The force vector to apply to the object
Returns void
- Defined in index.ts:1399

checkCollision

checkCollision(object): boolean | Boolean
Checks for a collision with another object
Parameters
- object: GameObject
  The object to check for a collision with
Returns boolean | Boolean
Boolean, true of the object is colliding with the other object, false otherwise
- Defined in index.ts:1541

checkPolygonalCollision

checkPolygonalCollision(polygon): boolean | Boolean
Checks for a collision with a polygon
Parameters
- polygon: Vec2[]
  The polygon (lower case, not type Polygon) to check for a collision with
Returns boolean | Boolean
Boolean, true of the object is colliding with the other object, false otherwise
- Defined in index.ts:1558

disableBounds

disableBounds(): void
Disables bounds on that object

Returns void
- Defined in index.ts:1475

draw

draw(options): void
Draws the object on the provided drawing context, in accordance with the camera position. This is handled automatically with scene and scene managers
Parameters
- options: DrawOptions
  The DrawOptions for the object
Returns void
- Defined in index.ts:1458

drawLabel

drawLabel(options): void
Draws the object's label on top of the object The label is the objects meta label (eg: object.meta.label = "...")
Parameters
- options: DrawOptions
  The DrawOptions for the object
Returns void
- Defined in index.ts:1445

initialize

initialize(scene): void
Parameters
- scene: Scene
Returns void
- Defined in index.ts:1587

move

move(vector, continueAfterPhysics?): Boolean
Top level move function (works with both physics enabled and disabled)... needs helper functions getWidth(), getHeight() to be defined. Recommended to re-write based on your use case (if extending)
Parameters
- vector: Vec2
  Vector to move the object by
- continueAfterPhysics: boolean = true
  If set to false, the object will not move if physics are not enabled. If true, the object will move if physics are not enabled. True by defualt
Returns Boolean
Boolean, true if the move was successful, false if it was not (if it was out of bounds, it will not move)
- Defined in index.ts:1507

moveStatic

moveStatic(vector): true | Boolean
Moves an object that has physics enabled by a vector (no forces pr boundaries involved)
Parameters
- vector: Vec2
  The vector to move the object by
Returns true | Boolean
Whether the object was moved or not (if it was out of bounds, it will not move)
- Defined in index.ts:1492

moveTo

moveTo(point): void
Parameters
- point: Vec2
Returns void
- Defined in index.ts:1589

pin(object, to): void
Modifies pin to a game object
Parameters
- object: GameObject
  The game object to pin to
- to: "center" | "coordinates"
  The reference point to pin to (either "center" or "coordinates")
Returns void
- Defined in index.ts:1416

polify

polify(): Vec2[]
Returns the gameobject represented as an array of points.

Returns Vec2[]
An array of points (eg: objects bounds). used for collision detection
- Defined in index.ts:1425

polifyWithOffset

polifyWithOffset(offset): Vec2[]
Returns the gameobject represented as an array of points, with an offset applied.
Parameters
- offset: Vec2
  The offset to apply to the object
Returns Vec2[]
List of points that make up the object, with the offset applied
- Defined in index.ts:1435

returnState

returnState(): void
Returns to the old state (before state() was called). Used for clicking

Returns void
- Defined in index.ts:1361

serialize

serialize(): GameObjectOptions
Returns the object as a JSON object

Returns GameObjectOptions
The object as a JSON object
- Defined in index.ts:1325

setBounds

setBounds(bounds): void
Sets the object's bounds (where it can move)
Parameters
- bounds: number[]
  The bounds to set the object to
Returns void
- Defined in index.ts:1467

state

state(attr, value): void
Changes an attribute of the object (non destructive). To return to the original object, use returnState. Used for clicking
Parameters
- attr: string
  The attribute to change
- value: any
  The new value of that attribute
Returns void
- Defined in index.ts:1350

unpin

unpin(): void
Removes the pinned object

Returns void
- Defined in index.ts:1407

update

update(): void
Does nothing

Returns void
- Defined in index.ts:1573

updatePhysics

updatePhysics(): void
Updates object physics 1 tick

Returns void
- Defined in index.ts:1370

`Static` From

From(options): GameObject | Sprite | Polygon
Parameters
- options: GameObjectOptions
Returns GameObject | Sprite | Polygon
- Defined in index.ts:1293

Class GameObject

Classdesc

Example

Example

Hierarchy (view full)

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: GameObjectOptions = {}

Returns GameObject

Properties

_state

Type declaration

[key: string]: any

blockedBy

blocks

body

bounds

boundsActive

convex

coordinates

gameObjectOptions

hitbox

id

isLocalPlayer

meta

physicsEnabled

physicsOptions

pinRef

pinned

points

square

type

Methods

activateBounds

Returns void

applyForce

Parameters

vector: Vec2

Returns void

checkCollision

Parameters

object: GameObject

Returns boolean | Boolean

checkPolygonalCollision

Parameters

polygon: Vec2[]

Returns boolean | Boolean

disableBounds

Returns void

draw

Parameters

options: DrawOptions

Returns void

drawLabel

Parameters

options: DrawOptions

Returns void

initialize

Parameters

scene: Scene

Returns void

move

Parameters

vector: Vec2

continueAfterPhysics: boolean = true

Returns Boolean

moveStatic

Parameters

vector: Vec2

Returns true | Boolean

moveTo

Parameters

point: Vec2

Returns void

`Static` From