-
Notifications
You must be signed in to change notification settings - Fork 515
Atom Initialization
The /atom
initialization process has changed dramatically. All /atom
types including /turf
and /area
can use Initialize()
, and arguments to New()
are passed along to Initialize()
.
New()
and Initialize()
overrides should not be mixed when possible as one is not guaranteed to occur before the other; their order varies based on when the atom is created.
Overriding/defining New()
should be avoided when possible in favor of Initialize()
.
Initialize()
always has at least one argument: mapload
. It is always the first argument. mapload
is TRUE
if the atom is being initialized during map loading (such as at server startup), FALSE
otherwise. If any other arguments are passed to New()
, they will come after mapload. Initialize must return parent or call parent and return an initialization hint.
Example:
/obj/myobj/Initialize(mapload)
. = ..()
if (mapload)
world << "[src] initialized at mapload!"
else
world << "[src] initialized normally!"
Initialize can return a hint instead of parent (although parent should still be called), allowing for special post-initialization behavior. The following hints are understood.
INITIALIZE_HINT_NORMAL
-> Default. Nothing special happens.
INITIALIZE_HINT_LATELOAD
-> LateInitialize()
is called.
INITIALIZE_HINT_QDEL
-> The atom is qdeleted after Initialize()
returns.
INITIALIZE_HINT_LATEQDEL
-> The atom is qdeleted after server initialization completes, or immediately after Initialize()
if the server is already initialized.
LateInitialize()
is another initialization proc that can be defined to do things that require the rest of the objects in the world to be initialized first. It does not need to return anything or call parent.
Example:
/obj/myobj/LateInitialize()
world << "[src] late initialized!"
LateInitialize()
will only be called if Initialize()
returns INITIALIZE_HINT_LATELOAD
. If the atom is initialized during server load, it will LateInitialize()
after all Initialize()
calls complete. If the atom is initialized later, LateInitialize()
will be called immediately after Initialize()
.
A collection of standards and guidelines applied to the codebase.
Documentation regarding common APIs which speed up feature implementation and should be known by all coders.
- Atom Initialization
- Garbage, Queued Deletion, and Destroy
- Callbacks
- Timers
- Lazy Lists
- Overlays
- Processing APIs
- Common Helpers
- Global Listeners
- Singletons
Documentation for less used APIs that are not often needed.
Documentation regarding our implementation of StonedMC (SMC).
Decrepit or unused systems.
- Dynamic Maps (Not to be confused with the newer away mission implementation.)