Game_Map | RPGMakerMV Library

Game_Map

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

class: Game_Map

Hierarchy

Game_Map

Index

Methods

Properties

Protected _battleback1Name

_battleback1Name: string

Protected _battleback2Name

_battleback2Name: string

Protected _commonEvents

_commonEvents: Array<Game_CommonEvent>

Protected _displayX

_displayX: number

Protected _displayY

_displayY: number

Protected _events

_events: Array<Game_Event>

Protected _interpreter

_interpreter: Game_Interpreter

Protected _mapId

_mapId: number

Protected _nameDisplay

_nameDisplay: boolean

Protected _needsRefresh

_needsRefresh: boolean

Protected _parallaxLoopX

_parallaxLoopX: boolean

Protected _parallaxLoopY

_parallaxLoopY: boolean

Protected _parallaxName

_parallaxName: string

Protected _parallaxSx

_parallaxSx: number

Protected _parallaxSy

_parallaxSy: number

Protected _parallaxX

_parallaxX: number

Protected _parallaxY

_parallaxY: number

Protected _parallaxZero

_parallaxZero: boolean

Protected _scrollDirection

_scrollDirection: number

Protected _scrollRest

_scrollRest: number

Protected _scrollSpeed

_scrollSpeed: number

Protected _tilesetId

_tilesetId: number

Protected _vehicles

_vehicles: Array<Game_Vehicle>

Methods

adjustX

adjustX(x: number): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4293
Parameters
- x: number
Returns number

adjustY

adjustY(y: number): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4294
Parameters
- y: number
Returns number

airship

airship(): Game_Vehicle

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4158
Returns the game airship.

memberof

Game_Map

Returns Game_Vehicle

allTiles

allTiles(x: number, y: number): Array<number>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4366
Parameters
- x: number
- y: number
Returns Array<number>

autoplay

autoplay(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4325
Auto plays the game map.

memberof

Game_Map

Returns void

autotileType

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4367
Parameters
- x: number
- y: number
- z: number
Returns number

battleback1Name

battleback1Name(): string

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4089
Returns the name of battle back 1.

memberof

Game_Map

Returns string

battleback2Name

battleback2Name(): string

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4096
Returns the name of battle back 2.

memberof

Game_Map

Returns string

boat

boat(): Game_Vehicle

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4144
Returns the game boat.

memberof

Game_Map

Returns Game_Vehicle

canvasToMapX

canvasToMapX(x: number): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4311
Converts the x coordinate from canvas to map coordinate x.

memberof

Game_Map

Parameters
- x: number
Returns number

canvasToMapY

canvasToMapY(y: number): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4319
Converts the y coordinate from canvas to map y coordinate.

memberof

Game_Map

Parameters
- y: number
Returns number

changeBattleback

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4424
Parameters
- battleback1Name: string
- battleback2Name: string
Returns void

changeParallax

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4425
Parameters
- name: string
- loopX: boolean
- loopY: boolean
- sx: number
- sy: number
Returns void

changeTileset

changeTileset(tilesetId: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4423
Changes them ap tileset, given the tileset id.

memberof

Game_Map

Parameters
- tilesetId: number
Returns void

checkLayeredTilesFlags

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4372
Parameters
- x: number
- y: number
- bit: number
Returns boolean

checkPassage

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4354
Parameters
- x: number
- y: number
- bit: number
Returns boolean

createVehicles

createVehicles(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4122
Creates the vehicles for the game map.

memberof

Game_Map

Returns void

data

data(): Array<number>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4236
Returns the map data.

memberof

Game_Map

Returns Array<number>

deltaX

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4301
Parameters
- x1: number
- x2: number
Returns number

deltaY

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4302
Parameters
- y1: number
- y2: number
Returns number

disableNameDisplay

disableNameDisplay(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4110
Disables name display.

memberof

Game_Map

Returns void

displayName

displayName(): string

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4215
Returns the display name of the game map.

memberof

Game_Map

Returns string

displayX

displayX(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4074
Returns the display x coordinate.

memberof

Game_Map

Returns number

displayY

displayY(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4081
Returns the display y coordinate.

memberof

Game_Map

Returns number

distance

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4303
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns number

doScroll

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4398
Parameters
- direction: number
- distance: number
Returns void

enableNameDisplay

enableNameDisplay(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4116
Enable name display.

memberof

Game_Map

Returns void

encounterList

encounterList(): Array<Encounter>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4264
Returns the list of possible encounters on the current map.

memberof

Game_Map

Returns Array<Encounter>

encounterStep

encounterStep(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4271
Returns the number of encounter steps on the map.

memberof

Game_Map

Returns number

eraseEvent

eraseEvent(eventId: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4181
Erases the event given the event id.

memberof

Game_Map

Parameters
- eventId: number
Returns void

event

event(eventId: number): Game_Event

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4174
Returns an event, given the event id.

memberof

Game_Map

Parameters
- eventId: number
Returns Game_Event

eventIdXy

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4340
Parameters
- x: number
- y: number
Returns number

events

events(): Array<Game_Event>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4166
Returns all events on the game map.

memberof

Game_Map

Returns Array<Game_Event>

eventsXy

eventsXy(x: number, y: number): Array<Game_Event>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4337
Returns the game events at the specified x and y position.

memberof

Game_Map

Parameters
- x: number
- y: number
Returns Array<Game_Event>

eventsXyNt

eventsXyNt(x: number, y: number): Array<Game_Event>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4338
Parameters
- x: number
- y: number
Returns Array<Game_Event>

height

height(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4229
Returns the map height.

memberof

Game_Map

Returns number

isAirshipLandOk

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4371
Parameters
- x: number
- y: number
Returns boolean

isAnyEventStarting

isAnyEventStarting(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4455
Returns true if any event is starting on the map.

memberof

Game_Map

Returns boolean

isBoatPassable

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4369
Parameters
- x: number
- y: number
Returns boolean

isBush

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4382
Parameters
- x: number
- y: number
Returns boolean

isCounter

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4383
Parameters
- x: number
- y: number
Returns boolean

isDamageFloor

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4384
Parameters
- x: number
- y: number
Returns boolean

isDashDisabled

isDashDisabled(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4257
Returns true if dash is disabled on the map.

memberof

Game_Map

Returns boolean

isEventRunning

isEventRunning(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4039
Returns true if an event is running.

memberof

Game_Map

Returns boolean

isLadder

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4381
Returns true if the specified element at the given x and y coordinates is a ladder.

memberof

Game_Map

Parameters
- x: number
- y: number
Returns boolean

isLoopHorizontal

isLoopHorizontal(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4243
Returns true if the map loops horizontally.

memberof

Game_Map

Returns boolean

isLoopVertical

isLoopVertical(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4250
Returns true if the map loops vertically.

memberof

Game_Map

Returns boolean

isNameDisplayEnabled

isNameDisplayEnabled(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4104
Returns true if the name display is enabled.

memberof

Game_Map

Returns boolean

isOverworld

isOverworld(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4278
Returns true if the map is an over world map.

memberof

Game_Map

Returns boolean

isPassable

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4368
Parameters
- x: number
- y: number
- d: number
Returns boolean

isScrolling

isScrolling(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4388
Returns boolean

isShipPassable

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4370
Parameters
- x: number
- y: number
Returns boolean

isValid

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4353
Returns true if the x and y coordinates are valid.

memberof

Game_Map

Parameters
- x: number
- y: number
Returns boolean

layeredTiles

layeredTiles(x: number, y: number): Array<number>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4365
Parameters
- x: number
- y: number
Returns Array<number>

mapId

mapId(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4060
Returns map id.

memberof

Game_Map

Returns number

parallaxName

parallaxName(): string

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4082
Returns string

parallaxOx

parallaxOx(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4193
Returns number

parallaxOy

parallaxOy(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4194
Returns number

parallelCommonEvents

parallelCommonEvents(): Array<CommonEvent>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4188
Returns all the parallel running common events.

memberof

Game_Map

Returns Array<CommonEvent>

refereshVehicles

refereshVehicles(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4128
Refreshes the vehicles on the game map.

memberof

Game_Map

Returns void

refresh

refresh(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4327
Returns void

refreshIfNeeded

refreshIfNeeded(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4326
Returns void

refreshTileEvents

refreshTileEvents(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4328
Returns void

regionId

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4386
Parameters
- x: number
- y: number
Returns number

requestRefresh

requestRefresh(mapId: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4097
Parameters
- mapId: number
Returns void

roundX

roundX(x: number): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4295
Parameters
- x: number
Returns number

roundXWithDirection

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4299
Parameters
- x: number
- d: number
Returns number

roundY

roundY(y: number): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4296
Parameters
- y: number
Returns number

roundYWithDirection

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4300
Parameters
- y: number
- d: number
Returns number

screenTileX

screenTileX(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4285
Returns the screen tile x coordinate.

memberof

Game_Map

Returns number

screenTileY

screenTileY(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4292
Returns the screen tile y coordinate.

memberof

Game_Map

Returns number

scrollDistance

scrollDistance(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4397
Returns number

scrollDown

scrollDown(distance: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4341
Parameters
- distance: number
Returns void

scrollLeft

scrollLeft(distance: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4342
Parameters
- distance: number
Returns void

scrollRight

scrollRight(distance: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4343
Parameters
- distance: number
Returns void

scrollUp

scrollUp(distance: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4344
Parameters
- distance: number
Returns void

setDisplayPos

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4192
Parameters
- x: number
- y: number
Returns void

setup

setup(mapId: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4032
Parameters
- mapId: number
Returns void

setupAutorunCommonEvent

setupAutorunCommonEvent(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4448
Sets up an auto run common event.

memberof

Game_Map

Returns boolean

setupBattleback

setupBattleback(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4191
Returns void

setupEvents

setupEvents(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4159
Returns void

setupParallax

setupParallax(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4190
Returns void

setupScroll

setupScroll(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4189
Returns void

setupStartingEvent

setupStartingEvent(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4439
Returns boolean

setupStartingMapEvent

setupStartingMapEvent(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4441
Returns boolean

setupTestEvent

setupTestEvent(): boolean

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4440
Returns boolean

ship

ship(): Game_Vehicle

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4151
Returns the game ship.

memberof

Game_Map

Returns Game_Vehicle

startScroll

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4387
Parameters
- direction: number
- distance: number
- speed: number
Returns void

terrainTag

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4385
Parameters
- x: number
- y: number
Returns number

tileEventsXy

tileEventsXy(x: number, y: number): Array<Game_Event>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4339
Parameters
- x: number
- y: number
Returns Array<Game_Event>

tileHeight

tileHeight(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4053
Returns tile height.

memberof

Game_Map

Returns number

tileId

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4364
Returns the tile id at the specified x, y, and z coordinates.

memberof

Game_Map

Parameters
- x: number
- y: number
- z: number
Returns number

tileWidth

tileWidth(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4046
Returns tile width.

memberof

Game_Map

Returns number

tileset

tileset(): Tileset

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4201
Returns the tilset of the game map.

memberof

Game_Map

Returns Tileset

tilesetFlags

tilesetFlags(): Array<number>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4208
Returns the tileset flags of the game map.

memberof

Game_Map

Returns Array<number>

tilesetId

tilesetId(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4067
Returns the tileset id.

memberof

Game_Map

Returns number

unlockEvent

unlockEvent(eventId: number): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4438
Unlocks an event on the map given the event id.

memberof

Game_Map

Parameters
- eventId: number
Returns void

update

update(sceneActive: boolean): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4395
Updates the game map, given that the scene is active.

memberof

Game_Map

Parameters
- sceneActive: boolean
Returns void

updateEvents

updateEvents(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4404
Updates all events on the map.

memberof

Game_Map

Returns void

updateInterpreter

updateInterpreter(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4431
Updates the map's game interpreter.

memberof

Game_Map

Returns void

updateParallax

updateParallax(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4416
Updates the map parallaxes.

memberof

Game_Map

Returns void

updateScroll

updateScroll(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4396
Returns void

updateVehicles

updateVehicles(): void

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4410
Updates all game vehicles on the map.

memberof

Game_Map

Returns void

vehicle

vehicle(type: string): Game_Vehicle

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4137
Returns the game vehicle specified by type.

memberof

Game_Map

Parameters
- type: string
Returns Game_Vehicle

vehicles

vehicles(): Array<Game_Vehicle>

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4129
Returns Array<Game_Vehicle>

width

width(): number

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4222
Returns the map width.

memberof

Game_Map

Returns number

xWithDirection

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4297
Parameters
- x: number
- d: number
Returns number

yWithDirection

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

- Defined in js/rmmv-ts/src/rpg_objects.d.ts:4298
Parameters
- y: number
- d: number
Returns number

Hierarchy

Index

Properties

Methods

Properties

Protected _battleback1Name

Protected _battleback2Name

Protected _commonEvents

Protected _displayX

Protected _displayY

Protected _events

Protected _interpreter

Protected _mapId

Protected _nameDisplay

Protected _needsRefresh

Protected _parallaxLoopX

Protected _parallaxLoopY

Protected _parallaxName

Protected _parallaxSx

Protected _parallaxSy

Protected _parallaxX

Protected _parallaxY

Protected _parallaxZero

Protected _scrollDirection

Protected _scrollRest

Protected _scrollSpeed

Protected _tilesetId

Protected _vehicles

Methods

adjustX

Parameters

x: number

Returns number

adjustY

Parameters

y: number

Returns number

airship

Returns Game_Vehicle

allTiles

Parameters

x: number

y: number

Returns Array<number>

autoplay

Returns void

autotileType

Parameters

x: number

y: number

z: number

Returns number

battleback1Name

Returns string

battleback2Name

Returns string

boat

Returns Game_Vehicle

canvasToMapX

Parameters

x: number

Returns number

canvasToMapY

Parameters

y: number

Returns number

changeBattleback

Parameters

battleback1Name: string

battleback2Name: string

Returns void

changeParallax

Parameters

name: string

loopX: boolean

loopY: boolean

sx: number

sy: number

Returns void

changeTileset