Add ref location notes to some builtins

This commit is contained in:
Tad Hardesty 2020-12-06 16:10:26 -08:00
parent 730ce571fd
commit 86899bfd54

View file

@ -217,8 +217,9 @@ pub fn register_builtins(tree: &mut ObjectTree) -> Result<(), DMError> {
}
entries! {
var/const/vars;
// directions
var/const/vars; // "/DM/vars"
// enum /atom/var/dir
var/const/NORTH = int!(1);
var/const/SOUTH = int!(2);
var/const/EAST = int!(4);
@ -230,7 +231,7 @@ pub fn register_builtins(tree: &mut ObjectTree) -> Result<(), DMError> {
var/const/UP = int!(16);
var/const/DOWN = int!(32);
// eye and sight
// enum /mob/var/sight
var/const/BLIND = int!(1);
var/const/SEE_MOBS = int!(4);
var/const/SEE_OBJS = int!(8);
@ -241,36 +242,39 @@ pub fn register_builtins(tree: &mut ObjectTree) -> Result<(), DMError> {
var/const/SEE_THRU = int!(512);
var/const/SEE_BLACKNESS = int!(1024);
// enum /client/var/perspective
var/const/MOB_PERSPECTIVE = int!(0);
var/const/EYE_PERSPECTIVE = int!(1);
var/const/EDGE_PERSPECTIVE = int!(2);
// layers
var/const/FLOAT_LAYER = int!(-1);
var/const/AREA_LAYER = int!(1);
var/const/FLOAT_LAYER = int!(-1); // "/atom/var/overlays"
var/const/AREA_LAYER = int!(1); // "/atom/var/layer"...
var/const/TURF_LAYER = int!(2);
var/const/OBJ_LAYER = int!(3);
var/const/MOB_LAYER = int!(4);
var/const/FLY_LAYER = int!(5);
var/const/EFFECTS_LAYER = int!(5000);
var/const/TOPDOWN_LAYER = int!(10000);
var/const/BACKGROUND_LAYER = int!(20000);
var/const/FLOAT_PLANE = int!(-32767);
var/const/EFFECTS_LAYER = int!(5000); // "/{notes}/EFFECTS_LAYER"
var/const/TOPDOWN_LAYER = int!(10000); // "/{notes}/TOPDOWN_LAYER"
var/const/BACKGROUND_LAYER = int!(20000); // "/{notes}/BACKGROUND_LAYER"
var/const/FLOAT_PLANE = int!(-32767); // "/atom/var/plane"
// map formats
var/const/TOPDOWN_MAP = int!(0);
var/const/ISOMETRIC_MAP = int!(1);
var/const/SIDE_MAP = int!(2);
var/const/TILED_ICON_MAP = int!(32768);
// enum /world/var/map_format
var/const/TOPDOWN_MAP = int!(0); // "/{notes}/topdown"
var/const/ISOMETRIC_MAP = int!(1); // "/{notes}/isometric"
var/const/SIDE_MAP = int!(2); // "/{notes}/side"
var/const/TILED_ICON_MAP = int!(32768); // "/{notes}/tiled-icons"
var/const/TRUE = int!(1);
var/const/FALSE = int!(0);
// enum /mob/var/gender
var/const/MALE = string!("male");
var/const/FEMALE = string!("female");
var/const/NEUTER = string!("neuter");
var/const/PLURAL = string!("plural");
// enum /DM/mouse/pointers
var/const/MOUSE_INACTIVE_POINTER = int!(0);
var/const/MOUSE_ACTIVE_POINTER = int!(1);
var/const/MOUSE_DRAG_POINTER = int!(3);
@ -286,16 +290,17 @@ pub fn register_builtins(tree: &mut ObjectTree) -> Result<(), DMError> {
var/const/MOUSE_SHIFT_KEY = int!(16);
var/const/MOUSE_ALT_KEY = int!(32);
// enum /world/var/system_type
var/const/MS_WINDOWS = string!("MS Windows");
var/const/UNIX = string!("UNIX");
// sound
// enum /sound/var/status
var/const/SOUND_MUTE = int!(1);
var/const/SOUND_PAUSED = int!(2);
var/const/SOUND_STREAM = int!(4);
var/const/SOUND_UPDATE = int!(16);
// blend_mode
// enum /atom/var/blend_mode
var/const/BLEND_DEFAULT = int!(0);
var/const/BLEND_OVERLAY = int!(1);
var/const/BLEND_ADD = int!(2);
@ -306,25 +311,27 @@ pub fn register_builtins(tree: &mut ObjectTree) -> Result<(), DMError> {
// this is just a procstyle syntax wrapper for \ref[foo]
proc/ref(A);
// alpha mask filter
// alpha mask filter, /{notes}/filters/alpha
var/const/MASK_INVERSE = int!(1);
var/const/MASK_SWAP = int!(2);
// rgb filter
// rgb filter, /{notes}/filters/color
var/const/FILTER_COLOR_RGB = int!(0);
var/const/FILTER_COLOR_HSV = int!(1);
var/const/FILTER_COLOR_HSL = int!(2);
var/const/FILTER_COLOR_HCY = int!(3);
// layering / ray filter
// described in /{notes}/filters/rays
// also mentioned in /{notes}/filters/layer
var/const/FILTER_OVERLAY = int!(1);
var/const/FILTER_UNDERLAY = int!(2);
// wave filter / ripple filter
var/const/WAVE_SIDEWAYS = int!(1);
var/const/WAVE_BOUNDED = int!(2);
var/const/WAVE_SIDEWAYS = int!(1); // wave only, "/{notes}/filters/wave"
var/const/WAVE_BOUNDED = int!(2); // wave and also "/{notes}/filters/ripple"
// outline filter
// outline filter, /{notes}/filters/outline
var/const/OUTLINE_SHARP = int!(1);
var/const/OUTLINE_SQUARE = int!(2);