Interface GameInstance

Game entity or instance interface compatible with the Lens camera system.

interface GameInstance {
    dir?: any;
    getPos?: () => { x: number; y: number };
    height?: number;
    icon?: { height: number; width: number };
    isMoving?: boolean;
    mapName?: string;
    sprite?: { height: number; width: number };
    width?: number;
    x?: number;
    xIconOffset?: number;
    y?: number;
    yIconOffset?: number;
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

dir? getPos? height? icon? isMoving? mapName? sprite? width? x? xIconOffset? y? yIconOffset?

Properties

Optionaldir

dir?: any

Current movement direction of the entity

OptionalgetPos

getPos?: () => { x: number; y: number }

Function returning current world coordinates

Optionalheight

height?: number

Entity height in pixels

Optionalicon

icon?: { height: number; width: number }

Entity icon graphic dimensions

OptionalisMoving

isMoving?: boolean

Whether the entity is currently moving

OptionalmapName

mapName?: string

Name of the current map/world layer

Optionalsprite

sprite?: { height: number; width: number }

Entity sprite graphic dimensions

Optionalwidth

width?: number

Entity width in pixels

Optionalx

x?: number

World X coordinate

OptionalxIconOffset

xIconOffset?: number

Visual X offset for the entity icon

Optionaly

y?: number

World Y coordinate

OptionalyIconOffset

yIconOffset?: number

Visual Y offset for the entity icon

Settings

Member Visibility

On This Page

Properties