api.md

API

• Actors
• Base
• Drawing
• Event Handling
• Files
• Intermission Screens
• Level Data
• Players
• Sounds
• Weapons
• Global Objects

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

• State

TODO

Base

• Array
• CVar
• Color
• FixedArray
• Object
• StringTable
• String
• Thinker
• Vector

TODO

Drawing

• BrokenLines
• Console
• Font
• GIFont
• Screen
• Shape2D
• TexMan
• TextureID

TODO

Event Handling

• ConsoleEvent
• EventHandler
• RenderEvent
• ReplaceEvent
• StaticEventHandler

TODO

Files

• Wads

TODO

Intermission Screens

• InterBackground
• PatchInfo
• StatusScreen
• WBPlayerStruct
• WBStartStruct

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

• F3DFloor
• FColorMap
• LineIdIterator
• Line
• SecPlane
• SecSpecial
• SectorEffect
• SectorTagIterator
• Sector
• Side
• Vertex

TODO

Players

• PlayerClass
• PlayerSkin
• Team

TODO

Sounds

• SeqNode

TODO

Weapons

• PSprite

TODO

Global Objects

• Client
• Constants
• Game
• Information
• Player

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

• Classes
• Game
• Math
• Random
• Sound
• System

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

• DehInfo
• FOptionMenuSettings
• GameInfoStruct
• LevelLocals

These are the types used by global variables.