misc.dm

#define DEBUG
// Turf-only flags.
#define TURF_FLAG_NOJAUNT               BITFLAG(0) // This is used in literally one place, turf.dm, to block ethereal jaunt.
#define TURF_FLAG_NO_POINTS_OF_INTEREST BITFLAG(1) // Used by the level subtemplate generator to skip placing loaded templates on this turf.
#define TURF_FLAG_BACKGROUND            BITFLAG(2) // Used by shuttle movement to determine if it should be ignored by turf translation.
#define TURF_FLAG_HOLY                  BITFLAG(3)
#define TURF_FLAG_ABSORB_LIQUID         BITFLAG(4)
#define TURF_IS_HOLOMAP_OBSTACLE        BITFLAG(5)
#define TURF_IS_HOLOMAP_PATH            BITFLAG(6)
#define TURF_IS_HOLOMAP_ROCK            BITFLAG(7)

///Width or height of a transition edge area along the map's borders where transition edge turfs are placed to connect levels together.
#define TRANSITIONEDGE 7

///Enum value for a level edge that's to be untouched
#define LEVEL_EDGE_NONE 0
///Enum value for a level edge that's to be looped with the opposite edge
#define LEVEL_EDGE_LOOP 1
///Enum value for a level edge that's to be filled with a wall filler turfs
#define LEVEL_EDGE_WALL 2
///Enum value for a level edge that's to be connected with another z-level
#define LEVEL_EDGE_CON  3

// Invisibility constants.
#define INVISIBILITY_NONE         0
#define INVISIBILITY_LIGHTING    20
#define INVISIBILITY_LEVEL_ONE   35
#define INVISIBILITY_LEVEL_TWO   45
#define INVISIBILITY_OVERMAP     50
#define INVISIBILITY_OBSERVER    60
#define INVISIBILITY_EYE         61
#define INVISIBILITY_SYSTEM      99
#define INVISIBILITY_ABSTRACT   101	// special: this can never be seen, regardless of see_invisible

#define SEE_INVISIBLE_LIVING     25
#define SEE_INVISIBLE_NOLIGHTING 15
#define SEE_INVISIBLE_LEVEL_ONE  INVISIBILITY_LEVEL_ONE
#define SEE_INVISIBLE_LEVEL_TWO  INVISIBILITY_LEVEL_TWO
#define SEE_INVISIBLE_CULT       INVISIBILITY_OBSERVER
#define SEE_INVISIBLE_OBSERVER   INVISIBILITY_EYE
#define SEE_INVISIBLE_SYSTEM     INVISIBILITY_SYSTEM

#define SEE_IN_DARK_DEFAULT 2

#define SEE_INVISIBLE_MINIMUM 5
#define INVISIBILITY_MAXIMUM 100

// Some arbitrary defines to be used by self-pruning global lists. (see master_controller)
#define PROCESS_KILL 26 // Used to trigger removal from a processing list.

// For secHUDs and medHUDs and variants. The number is the location of the image on the list hud_list of humans.
#define      HEALTH_HUD 1 // A simple line rounding the mob's number health.
#define      STATUS_HUD 2 // Alive, dead, diseased, etc.
#define          ID_HUD 3 // The job asigned to your ID.
#define      WANTED_HUD 4 // Wanted, released, paroled, security status.
#define    IMPLOYAL_HUD 5 // Loyalty implant.
#define     IMPCHEM_HUD 6 // Chemical implant.
#define    IMPTRACK_HUD 7 // Tracking implant.
#define SPECIALROLE_HUD 8 // AntagHUD image.
#define  STATUS_HUD_OOC 9 // STATUS_HUD without check for someone being ill.
#define 	  LIFE_HUD 10 // STATUS_HUD that only reports dead or alive

// Shuttle moving status.
#define SHUTTLE_IDLE      0
#define SHUTTLE_WARMUP    1
#define SHUTTLE_INTRANSIT 2

// Autodock shuttle processing status.
#define IDLE_STATE   0
#define WAIT_LAUNCH  1
#define FORCE_LAUNCH 2
#define WAIT_ARRIVE  3
#define WAIT_FINISH  4

// Setting this much higher than 1024 could allow spammers to DOS the server easily.
#define MAX_MESSAGE_LEN       1024
#define MAX_PAPER_MESSAGE_LEN 6144
#define MAX_BOOK_MESSAGE_LEN  18432
#define MAX_LNAME_LEN         64
#define MAX_NAME_LEN          26
#define MAX_DESC_LEN          128
#define MAX_TEXTFILE_LENGTH 128000		// 512GQ file

// Event defines.
#define EVENT_LEVEL_MUNDANE  1
#define EVENT_LEVEL_MODERATE 2
#define EVENT_LEVEL_MAJOR    3

//Area flags, possibly more to come
#define AREA_FLAG_RAD_SHIELDED            BITFLAG(1)  // Shielded from radiation, clearly.
#define AREA_FLAG_EXTERNAL                BITFLAG(2)  // External as in exposed to space, not outside in a nice, green, forest.
#define AREA_FLAG_ION_SHIELDED            BITFLAG(3)  // Shielded from ionospheric anomalies.
#define AREA_FLAG_NO_LEGACY_PERSISTENCE   BITFLAG(4)  // SSpersistence will not track values from this area.
#define AREA_FLAG_IS_BACKGROUND           BITFLAG(5)  // Blueprints can create areas on top of these areas. Cannot edit the name of or delete these areas.
#define AREA_FLAG_MAINTENANCE             BITFLAG(6)  // Area is a maintenance area.
#define AREA_FLAG_SHUTTLE                 BITFLAG(7)  // Area is a shuttle area.
#define AREA_FLAG_HALLWAY                 BITFLAG(8)  // Area is a public hallway suitable for event selection
#define AREA_FLAG_PRISON                  BITFLAG(9)  // Area is a prison for the purposes of brigging objectives.
#define AREA_FLAG_HOLY                    BITFLAG(10) // Area is holy for the purposes of marking turfs as cult-resistant.
#define AREA_FLAG_SECURITY                BITFLAG(11) // Area is security for the purposes of newscaster init.
#define AREA_FLAG_HIDE_FROM_HOLOMAP       BITFLAG(12) // if we shouldn't be drawn on station holomaps
#define AREA_FLAG_ALLOW_LEVEL_PERSISTENCE BITFLAG(13) // Whether or not this area should pass changed turfs to SSpersistence.

//Map template flags
#define TEMPLATE_FLAG_ALLOW_DUPLICATES    BITFLAG(0)  // Lets multiple copies of the template to be spawned
#define TEMPLATE_FLAG_SPAWN_GUARANTEED    BITFLAG(1)  // Makes it ignore away site budget and just spawn (only for away sites)
#define TEMPLATE_FLAG_CLEAR_CONTENTS      BITFLAG(2)  // if it should destroy objects it spawns on top of
#define TEMPLATE_FLAG_NO_RUINS            BITFLAG(3)  // if it should forbid ruins from spawning on top of it
#define TEMPLATE_FLAG_NO_RADS             BITFLAG(4)  // Removes all radiation from the template after spawning.
#define TEMPLATE_FLAG_TEST_DUPLICATES     BITFLAG(5)  // Makes unit testing attempt to spawn mutliple copies of this template. Assumes unit testing is spawning at least one copy.
#define TEMPLATE_FLAG_GENERIC_REPEATABLE  BITFLAG(6) // Template can be picked repeatedly for the same level gen run.

// Convoluted setup so defines can be supplied by Bay12 main server compile script.
// Should still work fine for people jamming the icons into their repo.
#ifndef CUSTOM_ITEM_CONFIG
#define CUSTOM_ITEM_CONFIG "config/custom_items/"
#endif
#ifndef CUSTOM_ICON_CONFIG
#define CUSTOM_ICON_CONFIG "config/custom_icons/"
#endif

#define WALL_CAN_OPEN 1
#define WALL_OPENING 2

#define BOMBCAP_DVSTN_RADIUS (global.max_explosion_range/4)
#define BOMBCAP_HEAVY_RADIUS (global.max_explosion_range/2)
#define BOMBCAP_LIGHT_RADIUS global.max_explosion_range
#define BOMBCAP_FLASH_RADIUS (global.max_explosion_range*1.5)


// Special return values from bullet_act(). Positive return values are already used to indicate the blocked level of the projectile.
#define PROJECTILE_CONTINUE   -1 //if the projectile should continue flying after calling bullet_act()
#define PROJECTILE_FORCE_MISS -2 //if the projectile should treat the attack as a miss (suppresses attack and admin logs) - only applies to mobs.

// Objective config enum values.
#define CONFIG_OBJECTIVE_NONE 2
#define CONFIG_OBJECTIVE_VERB 1
#define CONFIG_OBJECTIVE_ALL  0

// Server whitelist config enums.
#define CONFIG_SERVER_NO_WHITELIST      1
#define CONFIG_SERVER_JOBS_WHITELIST    2
#define CONFIG_SERVER_JOIN_WHITELIST    3
#define CONFIG_SERVER_CONNECT_WHITELIST 4

// Coating name color config enums
#define CONFIG_COATING_COLOR_NONE       1
#define CONFIG_COATING_COLOR_MIXTURE    2
#define CONFIG_COATING_COLOR_COMPONENTS 3

// Location for server whitelist file to load from.
#define CONFIG_SERVER_WHITELIST_FILE "config/server_whitelist.txt"

// How many times an AI tries to connect to APC before switching to low power mode.
#define AI_POWER_RESTORE_MAX_ATTEMPTS 3

// AI power restoration routine steps.
#define AI_RESTOREPOWER_FAILED -1
#define AI_RESTOREPOWER_IDLE 0
#define AI_RESTOREPOWER_STARTING 1
#define AI_RESTOREPOWER_DIAGNOSTICS 2
#define AI_RESTOREPOWER_CONNECTING 3
#define AI_RESTOREPOWER_CONNECTED 4
#define AI_RESTOREPOWER_COMPLETED 5

// AI button defines
#define AI_BUTTON_PROC_BELONGS_TO_CALLER 1
#define AI_BUTTON_INPUT_REQUIRES_SELECTION 2

// Values represented as Oxyloss. Can be tweaked, but make sure to use integers only.
#define AI_POWERUSAGE_LOWPOWER 1
#define AI_POWERUSAGE_RESTORATION 2
#define AI_POWERUSAGE_NORMAL 5
#define AI_POWERUSAGE_RECHARGING 7

// Above values get multiplied by this when converting AI oxyloss -> watts.
// For now, one oxyloss point equals 10kJ of energy, so normal AI uses 5 oxyloss per tick (50kW or 70kW if charging)
#define AI_POWERUSAGE_OXYLOSS_TO_WATTS_MULTIPLIER 10000

//Grid for Item Placement
#define CELLS 8								//Amount of cells per row/column in grid
#define CELLSIZE (world.icon_size/CELLS)	//Size of a cell in pixels

#define PIXEL_MULTIPLIER WORLD_ICON_SIZE/32

#define MIDNIGHT_ROLLOVER		864000	//number of deciseconds in a day

//Error handler defines
#define ERROR_USEFUL_LEN 2

#define RAD_LEVEL_LOW 1 // Around the level at which radiation starts to become harmful
#define RAD_LEVEL_MODERATE 25
#define RAD_LEVEL_HIGH 40
#define RAD_LEVEL_VERY_HIGH 100

#define RADIATION_THRESHOLD_CUTOFF 0.1	// Radiation will not affect a tile when below this value.

#define SUPPLY_SECURITY_ELEVATED 1
#define SUPPLY_SECURITY_HIGH 2

// secure gun authorization settings
#define UNAUTHORIZED      0
#define AUTHORIZED        1
#define ALWAYS_AUTHORIZED 2

// wrinkle states for clothes
#define WRINKLES_DEFAULT	0
#define WRINKLES_WRINKLY	1
#define WRINKLES_NONE		2

//Shuttle mission stages
#define SHUTTLE_MISSION_PLANNED  1
#define SHUTTLE_MISSION_STARTED  2
#define SHUTTLE_MISSION_FINISHED 3
#define SHUTTLE_MISSION_QUEUED   4

//Built-in email accounts
#define EMAIL_DOCUMENTS "document.server@internal-services.net"
#define EMAIL_SYSADMIN  "admin@internal-services.net"
#define EMAIL_BROADCAST "broadcast@internal-services.net"

//Stats for department goals etc
#define STAT_XENOPLANTS_SCANNED  "xenoplants_scanned"
#define STAT_XENOFAUNA_SCANNED  "xenofauna_scanned"
#define STAT_FLAGS_PLANTED  "planet_flags"

//Number of slots a modular computer has which can be tweaked via gear tweaks.
#define TWEAKABLE_COMPUTER_PART_SLOTS 7

//Lying animation
#define ANIM_LYING_TIME 2

//Planet habitability class
#define HABITABILITY_IDEAL  1 //For planets with optimal conditions.
#define HABITABILITY_OKAY   2 //For planets with survivable conditions.
#define HABITABILITY_BAD    3 //For planets with very hazardous environment.
#define HABITABILITY_DEAD   4 //For dead worlds(barren rocks with no atmosphere and etc..).

#ifndef WINDOWS_HTTP_POST_DLL_LOCATION
#define WINDOWS_HTTP_POST_DLL_LOCATION "lib/byhttp.dll"
#endif

#ifndef UNIX_HTTP_POST_DLL_LOCATION
#define UNIX_HTTP_POST_DLL_LOCATION "lib/libbyhttp.so"
#endif

#ifndef HTTP_POST_DLL_LOCATION
#define HTTP_POST_DLL_LOCATION (world.system_type == MS_WINDOWS ? WINDOWS_HTTP_POST_DLL_LOCATION : UNIX_HTTP_POST_DLL_LOCATION)
#endif

// Surgery candidate flags.
#define SURGERY_NO_ROBOTIC       BITFLAG(0)
#define SURGERY_NO_CRYSTAL       BITFLAG(1)
#define SURGERY_NO_FLESH         BITFLAG(2)
#define SURGERY_NEEDS_INCISION   BITFLAG(3)
#define SURGERY_NEEDS_RETRACTED  BITFLAG(4)
#define SURGERY_NEEDS_ENCASEMENT BITFLAG(5)

//Inserts 'a' or 'an' before X in ways \a doesn't allow
#define ADD_ARTICLE(X) "[(lowertext(X[1]) in global.vowels) ? "an" : "a"] [X]"
#define ADD_ARTICLE_GENDER(X, GENDER) (GENDER == PLURAL ? "some [X]" : ADD_ARTICLE(X))

//Request Console Department Types
#define RC_ASSIST 1		//Request Assistance
#define RC_SUPPLY 2		//Request Supplies
#define RC_INFO   4		//Relay Info

#define WORTH_TO_SUPPLY_POINTS_CONSTANT       0.03
#define WORTH_TO_SUPPLY_POINTS_ROUND_CONSTANT 5

#define ICON_STATE_WORLD "world"
#define ICON_STATE_INV   "inventory"

#define hex2num(X) text2num(X, 16)
/// Returns the hex value of a number given a value assumed to be a base-ten value, padded to a minimum length of 2.
#define num2hex(num) num2text(num, 2, 16)
/// Returns the hex value of a number given a value assumed to be a base-ten value, padded to a supplied minimum length.
#define num2hex_padded(num, len) num2text(num, len, 16)

//Turf/area values for 'this space is outside' checks
#define OUTSIDE_AREA null
#define OUTSIDE_NO   FALSE
#define OUTSIDE_YES  TRUE
#define OUTSIDE_UNCERTAIN null

// Weather exposure values for being rained on or hailed on.
#define WEATHER_IGNORE   -1
#define WEATHER_EXPOSED   0
#define WEATHER_ROOFED    1
#define WEATHER_PROTECTED 2

// Literacy check constants.
#define WRITTEN_SKIP     0
#define WRITTEN_PHYSICAL 1
#define WRITTEN_DIGITAL  2

// arbitrary low pressure bound for wind weather effects
#define MIN_WIND_PRESSURE 10

#define TYPE_IS_ABSTRACT(D) (initial(D.abstract_type) == D)
#define TYPE_IS_SPAWNABLE(D) (!TYPE_IS_ABSTRACT(D) && initial(D.is_spawnable_type))
#define INSTANCE_IS_ABSTRACT(D) (D.abstract_type == D.type)

//Damage stuff
#define ITEM_HEALTH_NO_DAMAGE -1

/// Causes the atom to ignore clicks, hovers, etc.
#define MOUSE_OPACITY_UNCLICKABLE 0
/// Causes the atom to catch clicks, hovers, etc.
#define MOUSE_OPACITY_NORMAL 1
/// Causes the atom to catch clicks, hovers, etc, taking priority over NORMAL for a shared pointer target.
#define MOUSE_OPACITY_PRIORITY 2

// Set on many base types.
#define DEFAULT_APPEARANCE_FLAGS (PIXEL_SCALE)

///Formats exceptions into a readable string with all the details.
#define EXCEPTION_TEXT(E) "'[E.name]' ('[E.type]'): '[E.file]':[E.line]:\n'[E.desc]'"

#define LEVEL_BELOW_PLATING 1
#define LEVEL_ABOVE_PLATING 2

// Defines for fluorescence (/atom/var/fluorescent)
/// Glows when under flourescent light
#define FLUORESCENT_GLOWS   1
/// Currently glowing due to flourescent light
#define FLUORESCENT_GLOWING 2

// Flags used for utensil-food interaction.
/// Solid or semi-solid food; chopsticks, forks.
#define UTENSIL_FLAG_COLLECT BITFLAG(0)
/// Soft, liquid or semi-liquid food; soups, stews, pudding.
#define UTENSIL_FLAG_SCOOP   BITFLAG(1)
/// Foods that need to be sliced before eating; steak, grapefruit.
#define UTENSIL_FLAG_SLICE   BITFLAG(2)
/// Unimplemented; condiments that are collected before being spread on other food.
#define UTENSIL_FLAG_SPREAD  BITFLAG(3)

// Default.
#define GROOMABLE_NONE  0
// Hair, feathers.
#define GROOMABLE_COMB  BITFLAG(0)
// Hair, beards.
#define GROOMABLE_BRUSH BITFLAG(1)
// Horns.
#define GROOMABLE_FILE  BITFLAG(2)

// Nothing to groom on this organ.
#define GROOMING_RESULT_FAILED  0
// Can groom somewhat (short hair with a comb)
#define GROOMING_RESULT_PARTIAL 1
// Can groom properly (long hair with a brush)
#define GROOMING_RESULT_SUCCESS 2

// Used by recipe selection.
#define RECIPE_CATEGORY_MICROWAVE   "microwave"
#define RECIPE_CATEGORY_POT         "pot"
#define RECIPE_CATEGORY_SKILLET     "skillet"
#define RECIPE_CATEGORY_BAKING_DISH "baking dish"

// So we want to have compile time guarantees these methods exist on local type, unfortunately 515 killed the .proc/procname and .verb/verbname syntax so we have to use nameof()
// For the record: GLOBAL_VERB_REF would be useless as verbs can't be global.

/// Call by name proc references, checks if the proc exists on either this type or as a global proc.
#define PROC_REF(X) (nameof(.proc/##X))
/// Call by name verb references, checks if the verb exists on either this type or as a global verb.
#define VERB_REF(X) (nameof(.verb/##X))

/// Call by name proc reference, checks if the proc exists on either the given type or as a global proc
#define TYPE_PROC_REF(TYPE, X) (nameof(##TYPE.proc/##X))
/// Call by name verb reference, checks if the verb exists on either the given type or as a global verb
#define TYPE_VERB_REF(TYPE, X) (nameof(##TYPE.verb/##X))

/// Call by name proc reference, checks if the proc is an existing global proc
#define GLOBAL_PROC_REF(X) (/proc/##X)

#define RADIAL_LABELS_NONE     0
#define RADIAL_LABELS_OFFSET   1
#define RADIAL_LABELS_CENTERED 2

#define CRAYON_DRAW_RUNE     "rune"
#define CRAYON_DRAW_GRAFFITI "graffiti"
#define CRAYON_DRAW_LETTER   "letter"
#define CRAYON_DRAW_ARROW    "arrow"

// Enum for results of is_space_movement_permitted()
// Note that it may also return an instance of /atom/movable, which acts as SPACE_MOVE_SUPPORTED.
#define SPACE_MOVE_SUPPORTED (-1) //! Mob should run space-slipping checks.
#define SPACE_MOVE_FORBIDDEN   0  //! Mob should begin spacedrift.
#define SPACE_MOVE_PERMITTED   1  //! Mob should stop/prevent spacedrift.

// Default UI style applied to client prefs.
#define DEFAULT_UI_STYLE /decl/ui_style/midnight

// Indicates a modifier will never expire.
#define MOB_MODIFIER_INDEFINITE (-1)

// Indicators for attack checking proc.
#define MM_ATTACK_TYPE_WEAPON      0
#define MM_ATTACK_TYPE_THROWN      1
#define MM_ATTACK_TYPE_PROJECTILE  2

#define MM_ATTACK_RESULT_NONE      0
#define MM_ATTACK_RESULT_DEFLECTED BITFLAG(0)
#define MM_ATTACK_RESULT_BLOCKED   BITFLAG(1)