Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.82 KB

README.md

File metadata and controls

51 lines (33 loc) · 2.82 KB
Raw

/tg/station Events Base

This repository is a descendant of the "events base". The events base is modular, meaning you should avoid editing code in the code folder itself.

resentment technical debt forinfinityandbyond

Adding a new module, where do I do it?

Modules should be individual features/edits, packed into one.

modular_event houses two folders: one called base, and the other named whatever the event is called. base should hold anything that makes sense and/or is likely to reuse in other events. For example, multiple events want to limit jobs to only assistant and cyborg. Thus, the limit_jobs module exists in base. However, only the Toolbox Tournament is interested in running tournaments, so the tournament module only exists in modular_event/toolbox_tournament.

_modular_event exists for one purpose: to run before code. Thus, this should only be used for non-modular changes that HAVE to run before code. Otherwise, just make your own __DEFINES file in your module.

Tips for writing modular code

BYOND overrides are done in the order of which they appear, and you can even override the same proc twice!

For example, let's consider station traits, which look like this:

/datum/controller/subsystem/processing/station/proc/SetupTraits()
	// Find station traits
	// Initialize some station traits

We don't want this in our events, but how do we change it modularly? Well, like this!

// Avoid putting `proc/` here, since this isn't the base
/datum/controller/subsystem/processing/station/SetupTraits()
	return

And...that's it! BYOND will use the latest override.

I need to make a non-modular change!

If you're confident you cannot make a change without editing something in code, do so while explicitly marking where it begins and ends. That way, it's easy for us to handle merge conflicts with // EVENT EDIT: Description and // END EVENT EDIT.

some_normal_code()
other_normal_code()
// EVENT EDIT: We needed to do something cool here
do_something_cool_for_event()
// END EVENT EDIT

That being said, a lot of non-modular changes can be allowed modularly upstream. It's totally fine to add new signals on the tgstation repository that are only registered by events, for example, signals are basically free.

If possible, contact a maintainer (specifically Mothblocks, if she's still around) for help with non-modular code, and especially in the realm of being able to make non-modular code modular through upstream edits.