Interface SpriteOptions

For configuring the properties of a sprite

SpriteOptions

Example

 const options: SpriteOptions = {
     url: "https://i.imgur.com/0xq2Mgj.png",
     coordinates: [0, 0],
     width: 100,
     height: 100
 }
interface SpriteOptions {
    _state?: any;
    backgroundColor?: string;
    blocks?: GameObject[];
    bounds?: Vec2;
    boundsActive?: boolean;
    convex?: boolean;
    coordinates: Vec2;
    gameObjectOptions?: GameObjectOptions;
    height: number;
    hitbox?: Vec2;
    id?: string;
    meta?: any;
    physicsEnabled?: boolean;
    physicsOptions?: PhysicsOptions;
    points?: Vec2[];
    square?: boolean;
    type?: string;
    url: string;
    width: number;
}

Hierarchy (view full)

Properties

_state? backgroundColor? blocks? bounds? boundsActive? convex? coordinates gameObjectOptions? height hitbox? id? meta? physicsEnabled? physicsOptions? points? square? type? url width

Properties

Optional _state

_state?: any

Internal state of the GameObject, do not modify, but you can pass an initial state to the GameObject (use "_state": { ...gameObject, ...newProperties})

Optional backgroundColor

backgroundColor?: string

CSS color, background color of the GameObject (only applies to polygons)

Optional blocks

blocks?: GameObject[]

Array of GameObjects that are blocked by this GameObject

Optional bounds

bounds?: Vec2

Set the bounds of the GameObject, by default bounds are not enabled

Optional boundsActive

boundsActive?: boolean

Set to true to enable bounds, default is false

Optional convex

convex?: boolean

Set to true to make the GameObject convex, default is false

coordinates

coordinates: Vec2

Initial coordinates of the sprite

Optional gameObjectOptions

gameObjectOptions?: GameObjectOptions

Options for the GameObject (applied to clones when cloned using GameObject.From())

height

height: number

Height of the sprite

Optional hitbox

hitbox?: Vec2

Set the hitbox of the GameObject, by default hitbox is not enabled

Optional id

id?: string

A unique id for the GameObject, generated automatically by default

Optional meta

meta?: any

Any meta data you want to store in the GameObject (Do not overwrite "label", "player", or "id" if you are using a MultiPlayerSceneManager)

Optional physicsEnabled

physicsEnabled?: boolean

Set to true to enable physics, default is false

Optional physicsOptions

physicsOptions?: PhysicsOptions

Options passed to matter.js engine

Optional points

points?: Vec2[]

Set the points of the GameObject, by default points are not enabled

Optional square

square?: boolean

Set to true to make the GameObject a square, default is false

Optional type

type?: string

Set the type of the GameObject, by defualt is "gameObject", "polygon", or "sprite"

url

url: string

Url of the image

width

width: number

Width of the sprite

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc