Back to Guides
MapleStory WorldsTW
MapleStory WorldsTWHow to Use the MapleStory Worlds API Reference
Verified against MapleStory Worlds Creator Center API Reference
Key takeaway
A detailed guide to the official MapleStory Worlds API Reference, including its eight reference families, entry format, execution-space badges, synchronization markers, API state badges, and log-message levels.
Detailed content
Reference families
- Components are functional units added to entities and expose properties and functions.
- Events describe occurrences in World APIs and can include properties and spatial information.
- Services provide core features used to build systems in a World.
- Logics contain game logic with properties and functions.
- Misc contains MapleStory Worlds-specific data types, constructors, properties, and functions.
- Enums group related values; Lua documents the platform's Lua 5.3 basis; LogMessages explains runtime messages.
How each API entry is organized
- The top of an entry identifies the API name and gives an overall description.
- Properties and functions are listed separately, including inherited members where applicable.
- Examples demonstrate ways to use the API.
- Signatures identify return type, member name, parameter type, and parameter name.
- Optional parameters use a =nil notation, while variable parameters use an any... args notation.
Execution and synchronization badges
- Sync marks values normally synchronized from server to client; ReadOnly marks values that cannot be overwritten.
- ControlOnly, MakerOnly, and ReleaseOnly restrict where a member can be used.
- ServerOnly and ClientOnly restrict calls to one execution space.
- Server and Client describe cross-space execution behavior.
- Space badges on events identify whether an event occurs on the server, client, editor, or all applicable spaces.
State, behavior, and log markers
- Yield indicates that script execution is suspended while the API runs; Static marks a globally accessible API.
- ScriptOverridable identifies a function that can be redefined, while Abstract identifies an API that cannot create a component by itself.
- Deprecated marks an API that should no longer be used; Preview marks an API that may change before final release.
- LIA identifies informational log messages, LWA identifies warnings, and LEA identifies errors that prevent normal results.
Prerequisites
- Access to MapleStory Worlds Maker
- Basic familiarity with Lua scripting
Practical steps
- Choose the reference family that matches the feature you are building.
- Read the entry description and check inherited properties and functions.
- Confirm return types, parameter types, optional parameters, and variable parameters before calling a member.
- Check every execution-space, synchronization, state, and behavior badge.
- Use the provided example as a starting point and interpret any LIA, LWA, or LEA log prefix before debugging further.
More from this series
This Guides entry belongs to MapleStory Worlds. Related pages below keep this series separate from other MapleStory games.
Source and verification
MPStorys keeps an original summary and structured facts on this site. The first-party page remains attached as a citation for dates, rules, and later corrections.
MapleStory Worlds Creator Center API Reference