Game_Map.d overview

Table of contents

• utils
  • Game_Map (class)
    • setup (method)
    • isEventRunning (method)
    • tileWidth (method)
    • tileHeight (method)
    • bushDepth (method)
    • mapId (method)
    • tilesetId (method)
    • displayX (method)
    • displayY (method)
    • parallaxName (method)
    • battleback1Name (method)
    • battleback2Name (method)
    • requestRefresh (method)
    • isNameDisplayEnabled (method)
    • disableNameDisplay (method)
    • enableNameDisplay (method)
    • createVehicles (method)
    • refereshVehicles (method)
    • vehicles (method)
    • vehicle (method)
    • boat (method)
    • ship (method)
    • airship (method)
    • setupEvents (method)
    • events (method)
    • event (method)
    • eraseEvent (method)
    • autorunCommonEvents (method)
    • parallelCommonEvents (method)
    • setupScroll (method)
    • setupParallax (method)
    • setupBattleback (method)
    • setDisplayPos (method)
    • parallaxOx (method)
    • parallaxOy (method)
    • tileset (method)
    • tilesetFlags (method)
    • displayName (method)
    • width (method)
    • height (method)
    • data (method)
    • isLoopHorizontal (method)
    • isLoopVertical (method)
    • isDashDisabled (method)
    • encounterList (method)
    • encounterStep (method)
    • isOverworld (method)
    • screenTileX (method)
    • screenTileY (method)
    • adjustX (method)
    • adjustY (method)
    • roundX (method)
    • roundY (method)
    • xWithDirection (method)
    • yWithDirection (method)
    • roundXWithDirection (method)
    • roundYWithDirection (method)
    • deltaX (method)
    • deltaY (method)
    • distance (method)
    • canvasToMapX (method)
    • canvasToMapY (method)
    • autoplay (method)
    • refreshIfNeeded (method)
    • refresh (method)
    • refreshTileEvents (method)
    • eventsXy (method)
    • eventsXyNt (method)
    • tileEventsXy (method)
    • eventIdXy (method)
    • scrollDown (method)
    • scrollLeft (method)
    • scrollRight (method)
    • scrollUp (method)
    • isValid (method)
    • checkPassage (method)
    • tileId (method)
    • layeredTiles (method)
    • allTiles (method)
    • autotileType (method)
    • isPassable (method)
    • isBoatPassable (method)
    • isShipPassable (method)
    • isAirshipLandOk (method)
    • checkLayeredTilesFlags (method)
    • isLadder (method)
    • isBush (method)
    • isCounter (method)
    • isDamageFloor (method)
    • terrainTag (method)
    • regionId (method)
    • startScroll (method)
    • isScrolling (method)
    • update (method)
    • updateScroll (method)
    • scrollDistance (method)
    • doScroll (method)
    • updateEvents (method)
    • updateVehicles (method)
    • updateParallax (method)
    • changeTileset (method)
    • changeBattleback (method)
    • changeParallax (method)
    • updateInterpreter (method)
    • unlockEvent (method)
    • setupStartingEvent (method)
    • setupTestEvent (method)
    • setupStartingMapEvent (method)
    • setupAutorunCommonEvent (method)
    • isAnyEventStarting (method)
    • _interpreter (property)
    • _mapId (property)
    • _tilesetId (property)
    • _events (property)
    • _commonEvents (property)
    • _tileEvents (property)
    • _vehicles (property)
    • _displayX (property)
    • _displayY (property)
    • _nameDisplay (property)
    • _scrollDirection (property)
    • _scrollRest (property)
    • _scrollSpeed (property)
    • _parallaxName (property)
    • _parallaxZero (property)
    • _parallaxLoopX (property)
    • _parallaxLoopY (property)
    • _parallaxSx (property)
    • _parallaxSy (property)
    • _parallaxX (property)
    • _parallaxY (property)
    • _battleback1Name (property)
    • _battleback2Name (property)
    • _needsRefresh (property)

utils

Game_Map (class)

Game_Map

The game object class for a map. It contains scrolling and passage // determination functions.

Signature

export declare class Game_Map {
  constructor()
}

setup (method)

Signature

setup(mapId: MapID): void

isEventRunning (method)

Signature

isEventRunning(): boolean

tileWidth (method)

Signature

tileWidth(): number

tileHeight (method)

Signature

tileHeight(): number

bushDepth (method)

Signature

bushDepth(): number

mapId (method)

Signature

mapId(): number

tilesetId (method)

Signature

tilesetId(): number

displayX (method)

Signature

displayX(): number

displayY (method)

Signature

displayY(): number

parallaxName (method)

Signature

parallaxName(): string

battleback1Name (method)

Signature

battleback1Name(): string | null

battleback2Name (method)

Signature

battleback2Name(): string | null

requestRefresh (method)

Signature

requestRefresh(): void

isNameDisplayEnabled (method)

Signature

isNameDisplayEnabled(): boolean

disableNameDisplay (method)

Signature

disableNameDisplay(): void

enableNameDisplay (method)

Signature

enableNameDisplay(): void

createVehicles (method)

Signature

createVehicles(): void

refereshVehicles (method)

Signature

refereshVehicles(): void

vehicles (method)

Signature

vehicles(): Game_Vehicle[]

vehicle (method)

Signature

vehicle(type: number | VehicleType): Game_Vehicle | null

boat (method)

Signature

boat(): Game_Vehicle

ship (method)

Signature

ship(): Game_Vehicle

airship (method)

Signature

airship(): Game_Vehicle

setupEvents (method)

Signature

setupEvents(): void

events (method)

Signature

events(): Game_Event[]

event (method)

Signature

event(eventId: EventID): Game_Event

eraseEvent (method)

Signature

eraseEvent(eventId: EventID): void

autorunCommonEvents (method)

Signature

autorunCommonEvents(): import("../data").DataCommonEvent[]

parallelCommonEvents (method)

Signature

parallelCommonEvents(): import("../data").DataCommonEvent[]

setupScroll (method)

Signature

setupScroll(): void

setupParallax (method)

Signature

setupParallax(): void

setupBattleback (method)

Signature

setupBattleback(): void

setDisplayPos (method)

Signature

setDisplayPos(x: number, y: number): void

parallaxOx (method)

Signature

parallaxOx(): number

parallaxOy (method)

Signature

parallaxOy(): number

tileset (method)

Signature

tileset(): import("../data").DataTileset

tilesetFlags (method)

Signature

tilesetFlags(): number[]

displayName (method)

Signature

displayName(): string

width (method)

Signature

width(): number

height (method)

Signature

height(): number

data (method)

Signature

data(): number[]

isLoopHorizontal (method)

Signature

isLoopHorizontal(): boolean

isLoopVertical (method)

Signature

isLoopVertical(): boolean

isDashDisabled (method)

Signature

isDashDisabled(): boolean

encounterList (method)

Signature

encounterList(): import("../data").DataEncounter[]

encounterStep (method)

Signature

encounterStep(): number

isOverworld (method)

Signature

isOverworld(): boolean

screenTileX (method)

Signature

screenTileX(): number

screenTileY (method)

Signature

screenTileY(): number

adjustX (method)

Signature

adjustX(x: number): number

adjustY (method)

Signature

adjustY(y: number): number

roundX (method)

Signature

roundX(x: number): number

roundY (method)

Signature

roundY(y: number): number

xWithDirection (method)

Signature

xWithDirection(x: number, d: Direction): number

yWithDirection (method)

Signature

yWithDirection(y: number, d: Direction): number

roundXWithDirection (method)

Signature

roundXWithDirection(x: number, d: Direction): number

roundYWithDirection (method)

Signature

roundYWithDirection(y: number, d: Direction): number

deltaX (method)

Signature

deltaX(x1: number, x2: number): number

deltaY (method)

Signature

deltaY(y1: number, y2: number): number

distance (method)

Signature

distance(x1: number, y1: number, x2: number, y2: number): number

canvasToMapX (method)

Signature

canvasToMapX(x: number): number

canvasToMapY (method)

Signature

canvasToMapY(y: number): number

autoplay (method)

Signature

autoplay(): void

refreshIfNeeded (method)

Signature

refreshIfNeeded(): void

refresh (method)

Signature

refresh(): void

refreshTileEvents (method)

Signature

refreshTileEvents(): void

eventsXy (method)

Signature

eventsXy(x: number, y: number): Game_Event[]

eventsXyNt (method)

Signature

eventsXyNt(x: number, y: number): Game_Event[]

tileEventsXy (method)

Signature

tileEventsXy(x: number, y: number): Game_Event[]

eventIdXy (method)

Signature

eventIdXy(x: number, y: number): number

scrollDown (method)

Signature

scrollDown(distance: number): void

scrollLeft (method)

Signature

scrollLeft(distance: number): void

scrollRight (method)

Signature

scrollRight(distance: number): void

scrollUp (method)

Signature

scrollUp(distance: number): void

isValid (method)

Signature

isValid(x: number, y: number): boolean

checkPassage (method)

Signature

checkPassage(x: number, y: number, bit: number): boolean

tileId (method)

Signature

tileId(x: number, y: number, z: number): number

layeredTiles (method)

Signature

layeredTiles(x: number, y: number): number[]

allTiles (method)

Signature

allTiles(x: number, y: number): number[]

autotileType (method)

Signature

autotileType(x: number, y: number, z: number): number

isPassable (method)

Signature

isPassable(x: number, y: number, d: Direction): boolean

isBoatPassable (method)

Signature

isBoatPassable(x: number, y: number): boolean

isShipPassable (method)

Signature

isShipPassable(x: number, y: number): boolean

isAirshipLandOk (method)

Signature

isAirshipLandOk(x: number, y: number): boolean

checkLayeredTilesFlags (method)

Signature

checkLayeredTilesFlags(x: number, y: number, bit: number): boolean

isLadder (method)

Signature

isLadder(x: number, y: number): boolean

isBush (method)

Signature

isBush(x: number, y: number): boolean

isCounter (method)

Signature

isCounter(x: number, y: number): boolean

isDamageFloor (method)

Signature

isDamageFloor(x: number, y: number): boolean

terrainTag (method)

Signature

terrainTag(x: number, y: number): number

regionId (method)

Signature

regionId(x: number, y: number): number

startScroll (method)

Signature

startScroll(direction: Direction, distance: number, speed: number): void

isScrolling (method)

Signature

isScrolling(): boolean

update (method)

Signature

update(sceneActive: boolean): void

updateScroll (method)

Signature

updateScroll(): void

scrollDistance (method)

Signature

scrollDistance(): number

doScroll (method)

Signature

doScroll(direction: Direction, distance: number): void

updateEvents (method)

Signature

updateEvents(): void

updateVehicles (method)

Signature

updateVehicles(): void

updateParallax (method)

Signature

updateParallax(): void

changeTileset (method)

Signature

changeTileset(tilesetId: number): void

changeBattleback (method)

Signature

changeBattleback(battleback1Name: string | null, battleback2Name: string | null): void

changeParallax (method)

Signature

changeParallax(name: string, loopX: boolean, loopY: boolean, sx: number, sy: number): void

updateInterpreter (method)

Signature

updateInterpreter(): void

unlockEvent (method)

Signature

unlockEvent(eventId: EventID): void

setupStartingEvent (method)

Signature

setupStartingEvent(): boolean

setupTestEvent (method)

Signature

setupTestEvent(): boolean

setupStartingMapEvent (method)

Signature

setupStartingMapEvent(): boolean

setupAutorunCommonEvent (method)

Signature

setupAutorunCommonEvent(): boolean

isAnyEventStarting (method)

Signature

isAnyEventStarting(): boolean

_interpreter (property)

Signature

_interpreter: Game_Interpreter

_mapId (property)

Signature

_mapId: number

_tilesetId (property)

Signature

_tilesetId: number

_events (property)

Signature

_events: Game_Event[]

_commonEvents (property)

Signature

_commonEvents: Game_CommonEvent[]

_tileEvents (property)

Signature

_tileEvents: Game_Event[]

_vehicles (property)

Signature

_vehicles: Game_Vehicle[]

_displayX (property)

Signature

_displayX: number

_displayY (property)

Signature

_displayY: number

_nameDisplay (property)

Signature

_nameDisplay: boolean

_scrollDirection (property)

Signature

_scrollDirection: Direction

_scrollRest (property)

Signature

_scrollRest: number

_scrollSpeed (property)

Signature

_scrollSpeed: number

_parallaxName (property)

Signature

_parallaxName: string

_parallaxZero (property)

Signature

_parallaxZero: boolean

_parallaxLoopX (property)

Signature

_parallaxLoopX: boolean

_parallaxLoopY (property)

Signature

_parallaxLoopY: boolean

_parallaxSx (property)

Signature

_parallaxSx: number

_parallaxSy (property)

Signature

_parallaxSy: number

_parallaxX (property)

Signature

_parallaxX: number

_parallaxY (property)

Signature

_parallaxY: number

_battleback1Name (property)

Signature

_battleback1Name: string | null

_battleback2Name (property)

Signature

_battleback2Name: string | null

_needsRefresh (property)

Signature

_needsRefresh: boolean