code/__DEFINES/subsystems.dm

Defines for subsystems and overlays Lots of important stuff in here, make sure you have your brain switched on when editing this file Timing subsystem
TIMER_UNIQUE	Don't run if there is an identical unique timer active
TIMER_OVERRIDE	For unique timers: Replace the old timer rather then not start this one
TIMER_CLIENT_TIME	Timing should be based on how timing progresses on clients, not the server.
TIMER_STOPPABLE	Timer can be stopped using deltimer()
TIMER_NO_HASH_WAIT	prevents distinguishing identical timers with the wait variable
TIMER_LOOP	Loops the timer repeatedly until qdeleted
TIMER_DELETE_ME	Delete the timer on parent datum Destroy() and when deltimer'd
TIMER_ID_NULL	Empty ID define
PROCESS_KILL	Used to trigger object removal from a processing list
Initialization subsystem
INITIALIZATION_INSSATOMS	New should not call Initialize
INITIALIZATION_INNEW_MAPLOAD	New should call Initialize(TRUE)
INITIALIZATION_INNEW_REGULAR	New should call Initialize(FALSE)
Initialization hints
INITIALIZE_HINT_NORMAL	Nothing happens
INITIALIZE_HINT_LATELOAD	call LateInitialize at the end of all atom Initalization
INITIALIZE_HINT_QDEL	Call qdel on the atom after intialization
INITIALIZE_HINT_ROUNDSTART	Call LateInitialize on roundstart
INITIALIZE_IMMEDIATE	type and all subtypes should always immediately call Initialize in New()
SS initialization hints
SS_INIT_FAILURE	Negative values incidate a failure or warning of some kind, positive are good. 0 and 1 are unused so that TRUE and FALSE are guarenteed to be invalid values. Subsystem failed to initialize entirely. Print a warning, log, and disable firing.
SS_INIT_NONE	The default return value which must be overriden. Will succeed with a warning.
SS_INIT_SUCCESS	Subsystem initialized sucessfully.
SS_INIT_NO_NEED	Successful, but don't print anything. Useful if subsystem was disabled.
SS initialization load orders
GAME_STATE_STARTUP	Game is loading
GAME_STATE_PREGAME	Game is loaded and in pregame lobby
GAME_STATE_SETTING_UP	Game is attempting to start the round
GAME_STATE_PLAYING	Game has round in progress
GAME_STATE_FINISHED	Game has round finished
addtimer	Create a new timer and add it to the queue.
SS_INIT_TIMER_KEY	The timer key used to know how long subsystem initialization takes

Define Details

#define
GAME_STATE_FINISHED

Game has round finished

#define
GAME_STATE_PLAYING

Game has round in progress

#define
GAME_STATE_PREGAME

Game is loaded and in pregame lobby

#define
GAME_STATE_SETTING_UP

Game is attempting to start the round

#define
GAME_STATE_STARTUP

Game is loading

#define
INITIALIZATION_INNEW_MAPLOAD

New should call Initialize(TRUE)

#define
INITIALIZATION_INNEW_REGULAR

New should call Initialize(FALSE)

#define
INITIALIZATION_INSSATOMS

New should not call Initialize

#define
INITIALIZE_HINT_LATELOAD

call LateInitialize at the end of all atom Initalization

The item will be added to the late_loaders list, this is iterated over after initalization of subsystems is complete and calls LateInitalize on the atom see this file for the LateIntialize proc

#define
INITIALIZE_HINT_NORMAL

Nothing happens

#define
INITIALIZE_HINT_QDEL

Call qdel on the atom after intialization

#define
INITIALIZE_HINT_ROUNDSTART

Call LateInitialize on roundstart

#define
INITIALIZE_IMMEDIATE
(X)

type and all subtypes should always immediately call Initialize in New()

#define
PROCESS_KILL

Used to trigger object removal from a processing list

#define
SS_INIT_FAILURE

Negative values incidate a failure or warning of some kind, positive are good. 0 and 1 are unused so that TRUE and FALSE are guarenteed to be invalid values. Subsystem failed to initialize entirely. Print a warning, log, and disable firing.

#define
SS_INIT_NONE

The default return value which must be overriden. Will succeed with a warning.

#define
SS_INIT_NO_NEED

Successful, but don't print anything. Useful if subsystem was disabled.

#define
SS_INIT_SUCCESS

Subsystem initialized sucessfully.

#define
SS_INIT_TIMER_KEY

The timer key used to know how long subsystem initialization takes

#define
TIMER_CLIENT_TIME

Timing should be based on how timing progresses on clients, not the server.

Tracking this is more expensive, should only be used in conjuction with things that have to progress client side, such as animate() or sound()

#define
TIMER_DELETE_ME

Delete the timer on parent datum Destroy() and when deltimer'd

#define
TIMER_ID_NULL

Empty ID define

#define
TIMER_LOOP

Loops the timer repeatedly until qdeleted

In most cases you want a subsystem instead, so don't use this unless you have a good reason

#define
TIMER_NO_HASH_WAIT

prevents distinguishing identical timers with the wait variable

To be used with TIMER_UNIQUE

#define
TIMER_OVERRIDE

For unique timers: Replace the old timer rather then not start this one

#define
TIMER_STOPPABLE

Timer can be stopped using deltimer()

#define
TIMER_UNIQUE

Don't run if there is an identical unique timer active

if the arguments to addtimer are the same as an existing timer, it doesn't create a new timer, and returns the id of the existing timer

#define
addtimer
(args ...)

Create a new timer and add it to the queue.

Arguments:
- callback the callback to call on timer finish
- wait deciseconds to run the timer for
- flags flags for this timer, see: code__DEFINES\subsystems.dm
- timer_subsystem the subsystem to insert this timer into

code/__DEFINES/subsystems.dm

Timing subsystem

Initialization subsystem

Initialization hints

SS initialization hints

SS initialization load orders

Define Details

#define GAME_STATE_FINISHED

#define GAME_STATE_PLAYING

#define GAME_STATE_PREGAME

#define GAME_STATE_SETTING_UP

#define GAME_STATE_STARTUP

#define INITIALIZATION_INNEW_MAPLOAD

#define INITIALIZATION_INNEW_REGULAR

#define INITIALIZATION_INSSATOMS

#define INITIALIZE_HINT_LATELOAD

#define INITIALIZE_HINT_NORMAL

#define INITIALIZE_HINT_QDEL

#define INITIALIZE_HINT_ROUNDSTART

#define INITIALIZE_IMMEDIATE (X)

#define PROCESS_KILL

#define SS_INIT_FAILURE

#define SS_INIT_NONE

#define SS_INIT_NO_NEED

#define SS_INIT_SUCCESS

#define SS_INIT_TIMER_KEY

#define TIMER_CLIENT_TIME

#define TIMER_DELETE_ME

#define TIMER_ID_NULL

#define TIMER_LOOP

#define TIMER_NO_HASH_WAIT

#define TIMER_OVERRIDE

#define TIMER_STOPPABLE

#define TIMER_UNIQUE

#define addtimer (args ...)