Skip to content
Lohikar edited this page Aug 7, 2017 · 2 revisions

SSoverlay is a new way to handle /atom overlays that allows for automatic overlay caching.

Do not mix add_overlay/cut_overlay with manual overlay list manipulation, SSoverlay will overwrite the overlay list!

Usage

/atom/add_overlay(image|text|icon|list(image|text|icon), priority = FALSE)

Arguments mimic arguments accepted by overlays += . If argument is a list, all contents of list are added to overlays. If priority is true, the overlay will be added as a priority overlay - it will not be removed by cut_overlay() and cut_overlays() UNLESS the call to cut_overlay() or cut_overlays() also has priority as true.

/atom/cut_overlay(image|text|icon|list(image|text|icon), priority = FALSE)

Removes the matching overlay image if it is present. Same arguments as add_overlay().

/atom/cut_overlays(priority = FALSE)

Removes all non-priority overlays from an object UNLESS priority is true.

/atom/copy_overlays(atom/other_atom, cut_old = FALSE)

Copies another atom's overlays (excluding priority) to this atom. If cut_old is true, this atom's existing overlays (excluding priority) will be cut first.

/atom/compile_overlays()

Forces the atom to immediately build its overlays list instead of waiting for SSoverlays to do it. Most of the time this shouldn't need to be called directly.

Standards and Guidelines

A collection of standards and guidelines applied to the codebase.

Common API Documentation

Documentation regarding common APIs which speed up feature implementation and should be known by all coders.

Less Common APIs

Documentation for less used APIs that are not often needed.

Subsystems

Documentation regarding our implementation of StonedMC (SMC).

Decrepit

Decrepit or unused systems.

  • Dynamic Maps (Not to be confused with the newer away mission implementation.)
Clone this wiki locally