Skip to main content

RPGJS home page

Player API

Player API
Common Commands
Components
Parameter Commands
Class Commands
Gold Commands
State Commands
Element Commands
Item Commands
Skill Commands
Variable Commands
Move Commands
GUI Commands
Effect Commands
Battle Commands

Map API

Map API
RpgMap
World Maps
Map Types

Client API

Client API
Rpg Client Engine

Hooks

Event hooks
Client Engine Hooks
Client Physics Hooks
Client Scene Hooks
Client Sprite Hooks
Server Engine Hooks
Server Event Hooks
Server Map Hooks
Server Player Hooks

Map API
Pages

Map API

Map API

Reference for RpgMap, world map helpers, controls, and event hooks used by created events.

Documentation Index
Fetch the complete documentation index at: https://v5.rpgjs.dev/llms.txt
Use this file to discover all available pages before exploring further.

Map API

This reference is generated from the JSDoc comments in packages/server/src/rooms/map.ts and packages/common/src/rooms/WorldMaps.ts.

Pages

RpgMap
World Maps
Map Types
Event hooks

Battle Commands RpgMap

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform