Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Scene_Map

The scene class of the map screen.

class

Scene_Map

extends

{Scene_Base}

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _active

_active: boolean

Protected _bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Protected _cacheAsBitmap

_cacheAsBitmap: boolean

Protected _cacheData

_cacheData: boolean

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[] | null

Protected _encounterEffectDuration

_encounterEffectDuration: number

Protected _fadeDuration

_fadeDuration: number

Protected _fadeSign

_fadeSign: number

Protected _fadeSprite

_fadeSprite: ScreenSprite

Protected _filters

_filters: Filter[] | null

Protected _imageReservationId

_imageReservationId: any | number

Protected _lastBoundsID

_lastBoundsID: number

Protected _localBoundsRect

_localBoundsRect: Rectangle

Protected _mapLoaded

_mapLoaded: boolean

Protected _mapNameWindow

_mapNameWindow: Window_MapName

Protected _mask

_mask: Graphics | Sprite

Protected _messageWindow

_messageWindow: Window_Message

Protected _scrollTextWindow

_scrollTextWindow: Window_ScrollText

Protected _spriteset

_spriteset: Spriteset_Map

Protected _touchCount

_touchCount: number

Protected _transfer

_transfer: boolean

Protected _waitCount

_waitCount: number

Protected _windowLayer

_windowLayer: WindowLayer

accessible

accessible: boolean

accessibleHint

accessibleHint: string | null

accessibleTitle

accessibleTitle: string | null

alpha

alpha: number

buttonMode

buttonMode: boolean

cacheAsBitmap

cacheAsBitmap: boolean

children

children: DisplayObject[]

cursor

cursor: string

defaultCursor

defaultCursor: string

filterArea

filterArea: Rectangle

filters

filters: Filter[] | null

height

height: number

hitArea

interactive

interactive: boolean

interactiveChildren

interactiveChildren: boolean

localTransform

localTransform: Matrix

mask

menuCalling

menuCalling: boolean

name

name: string | null

Protected onChildrenChange

onChildrenChange: function

Type declaration

    • (...args: any[]): void
    • Parameters

      • Rest ...args: any[]

      Returns void

parent

parent: Container

pivot

position

renderable

renderable: boolean

rotation

rotation: number

scale

skew

tabIndex

tabIndex: number

transform

transform: TransformBase

visible

visible: boolean

width

width: number

worldAlpha

worldAlpha: number

worldTransform

worldTransform: Matrix

worldVisible

worldVisible: boolean

x

x: number

y

y: number

Static EventEmitter

EventEmitter: object

Type declaration

  • constructor: function
    • Returns EventEmitter

  • prefixed: string | boolean

Static prefixed

prefixed: string | boolean

Methods

Protected _cacheAsBitmapDestroy

  • _cacheAsBitmapDestroy(options: boolean | any): void

Protected _calculateBounds

  • _calculateBounds(): void

Protected _calculateCachedBounds

Protected _destroyCachedDisplayObject

  • _destroyCachedDisplayObject(): void

Protected _getCachedLocalBounds

Protected _initCachedDisplayObject

Protected _initCachedDisplayObjectCanvas

Protected _recursivePostUpdateTransform

  • _recursivePostUpdateTransform(): void

Protected _renderCachedCanvas

Protected _renderCachedWebGL

Protected _renderCanvas

Protected _renderWebGL

addChild

addChildAt

addListener

addWindow

attachReservation

  • attachReservation(): void

calculateBounds

  • calculateBounds(): void

callMenu

  • callMenu(): void

checkGameover

  • checkGameover(): void

Protected containerUpdateTransform

  • containerUpdateTransform(): void

create

  • create(): void

createAllWindows

  • createAllWindows(): void

createDisplayObjects

  • createDisplayObjects(): void
  • Creates all the display objects on the map scene; this includes the sprites, window layer, windows, and more.

    memberof

    Scene_Map

    Returns void

createFadeSprite

  • createFadeSprite(white: boolean): void

createMapNameWindow

  • createMapNameWindow(): void

createMessageWindow

  • createMessageWindow(): void
  • Creates the message window for displaying text on the map scene. Commonly used with the showText command.

    memberof

    Scene_Map

    Returns void

createScrollTextWindow

  • createScrollTextWindow(): void

createSpriteset

  • createSpriteset(): void
  • Creates the spriteset on the map scene; this shows all the characters and events on the map.

    memberof

    Scene_Map

    Returns void

createWindowLayer

  • createWindowLayer(): void

destroy

detachReservation

  • detachReservation(): void

Protected displayObjectUpdateTransform

  • displayObjectUpdateTransform(): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol

      The event name.

    • Rest ...args: any[]

      Arguments that are passed to registered listeners

    Returns boolean

    true if the event had listeners, else false.

encounterEffectSpeed

  • encounterEffectSpeed(): number

eventNames

  • eventNames(): Array<string | symbol>
  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<string | symbol>

fadeInForTransfer

  • fadeInForTransfer(): void

fadeOutAll

  • fadeOutAll(): void

fadeOutForTransfer

  • fadeOutForTransfer(): void

fadeSpeed

  • fadeSpeed(): number

getBounds

getChildAt

getChildByName

getChildIndex

getGlobalPosition

  • getGlobalPosition(point?: Point, skipUpdate?: boolean): Point

getLocalBounds

isActive

  • isActive(): boolean

isBusy

  • isBusy(): boolean

isDebugCalled

  • isDebugCalled(): boolean

isFastForward

  • isFastForward(): boolean
  • Returns true if the player is holding down the confirm button to fast forward through text.

    memberof

    Scene_Map

    Returns boolean

isMapTouchOk

  • isMapTouchOk(): boolean
  • Returns true if the map scene is active and the player can move. Used for mouse movement on the map scene.

    memberof

    Scene_Map

    Returns boolean

isMenuCalled

  • isMenuCalled(): boolean

isMenuEnabled

  • isMenuEnabled(): boolean

isReady

  • isReady(): boolean

isSceneChangeOk

  • isSceneChangeOk(): boolean

launchBattle

  • launchBattle(): void

listeners

  • listeners(event: string | symbol): Function[]
  • listeners(event: string | symbol, exists: boolean): boolean
  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

      The event name.

    Returns Function[]

  • Check if there listeners for a given event. If exists argument is not true lists listeners.

    Parameters

    • event: string | symbol

      The event name.

    • exists: boolean

      Only check if there are listeners.

    Returns boolean

needsFadeIn

  • needsFadeIn(): boolean

needsSlowFadeOut

  • needsSlowFadeOut(): boolean

off

  • off(event: "added" | "removed" | string, fn?: Function, context?: any): this
  • Parameters

    • event: "added" | "removed" | string
    • Optional fn: Function
    • Optional context: any

    Returns this

on

  • on(event: "added" | "removed", fn: function, context?: any): this
  • on(event: string, fn: Function, context?: any): this
  • Parameters

    • event: "added" | "removed"
    • fn: function
    • Optional context: any

    Returns this

  • Parameters

    • event: string
    • fn: Function
    • Optional context: any

    Returns this

onMapLoaded

  • onMapLoaded(): void

once

  • once(event: "added" | "removed", fn: function, context?: any): this
  • once(event: string, fn: Function, context?: any): this
  • Parameters

    • event: "added" | "removed"
    • fn: function
    • Optional context: any

    Returns this

  • Parameters

    • event: string
    • fn: Function
    • Optional context: any

    Returns this

popScene

  • popScene(): void

processMapTouch

  • processMapTouch(): void
  • Processes the map touch and turns it into coordinates for the player character to move to.

    memberof

    Scene_Map

    Returns void

removeAllListeners

removeChild

removeChildAt

removeChildren

  • removeChildren(beginIndex?: number, endIndex?: number): DisplayObject[]
  • Parameters

    • Optional beginIndex: number
    • Optional endIndex: number

    Returns DisplayObject[]

removeListener

renderAdvancedWebGL

renderCanvas

renderWebGL

setChildIndex

setMaxListeners

  • setMaxListeners(): this
  • This function doesn't apply anymore.

    deprecated

    Returns this

setParent

setTransform

  • setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, pivotX?: number, pivotY?: number): DisplayObject
  • Parameters

    • Optional x: number
    • Optional y: number
    • Optional scaleX: number
    • Optional scaleY: number
    • Optional rotation: number
    • Optional skewX: number
    • Optional skewY: number
    • Optional pivotX: number
    • Optional pivotY: number

    Returns DisplayObject

slowFadeSpeed

  • slowFadeSpeed(): number

snapForBattleBackground

  • snapForBattleBackground(): void
  • Takes a snapshot of the map scene for displaying on the battle scene if no battleback is present.

    memberof

    Scene_Map

    Returns void

start

  • start(): void

startEncounterEffect

  • startEncounterEffect(): void

startFadeIn

  • startFadeIn(duration: number, white: boolean): void

startFadeOut

  • startFadeOut(duration: number, white: boolean): void

startFlashForEncounter

  • startFlashForEncounter(duration: number): void
  • Starts a flash encounter effect on the map scene given a duration of the flash.

    memberof

    Scene_Map

    Parameters

    • duration: number

    Returns void

stop

  • stop(): void

stopAudioOnBattleStart

  • stopAudioOnBattleStart(): void

swapChildren

terminate

  • terminate(): void

toGlobal

toLocal

trackedPointers

  • trackedPointers(): object

update

  • update(): void

updateCallDebug

  • updateCallDebug(): void

updateCallMenu

  • updateCallMenu(): void

updateChildren

  • updateChildren(): void

updateDestination

  • updateDestination(): void
  • Constantly checks if the player is touching the map, then processes a map touch for mouse based player character movement.

    memberof

    Scene_Map

    Returns void

updateEncounter

  • updateEncounter(): void

updateEncounterEffect

  • updateEncounterEffect(): void

updateFade

  • updateFade(): void

updateMain

  • updateMain(): void

updateMainMultiply

  • updateMainMultiply(): void

updateScene

  • updateScene(): void

updateTransferPlayer

  • updateTransferPlayer(): void
  • Checks if the player is transferring; if the player is transferring, move to a new map scene.

    memberof

    Scene_Map

    Returns void

updateTransform

  • updateTransform(): void

updateWaitCount

  • updateWaitCount(): boolean

Generated using TypeDoc