You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

api.md 4.4KB

API

The ZScript API (Advanced Programming Interface) is vast and has some holes which are hard to explain. Some parts are implemented in ways that don’t make sense to user code, but are fine to the engine. Because of this, the API shall be documented in pseudo-ZScript which gives an idea of how it works for the modder rather than for the engine.

Actors

TODO

Base

TODO

Drawing

TODO

Event Handling

TODO

Files

TODO

Intermission Screens

For legacy reasons, many intermission-related things may be prefixed with WI or WB. The abbreviation WI means World Intermission (the intermission screen was originally called “World Map” by Tom Hall) and WB meaning World Buffer, as this data was originally buffered into a specific memory address for statistics drivers.

Level Data

TODO

Players

TODO

Sounds

TODO

Weapons

TODO

Global Objects

These variables are accessible in any context and are not bound by any specific object. Generally these mirror global information within the engine itself.

These functions are accessible in any context and are not bound by any specific object. Generally these are utility functions.

These are the types used by global variables.