Search source documentation
Loading search index...
Civ13 source API reference
This reference is for DM contributors, distinct from the player wiki and official website.
It is generated from civ13.dme by SpacemanDMM dmdoc. Documentation coverage is incremental;
undocumented declarations and inactive preprocessor branches are not a complete API contract.
Start with /datum/callback and its /datum/callback/dynamic subtype for synchronous and asynchronous proc invocation. Browse the module and type trees for existing subsystem documentation.
Modules
- code
- __byond_version_compat
- __defines
- _helpers
- _onclick/hud
- client_macros
- controllers
- datums
- game
- dna/dna2
- mob
- objects
- controls
- effects
- items
- paper/photography
- stacks/money
- weapons
- map_metadata
- random
- structures
- blacksmithing
- door
- gladiator_control
- key_doors/types/groups
- kitchen/oven
- kitchen_spike
- minimap
- noticeboard
- religious
- roulette_table
- sea
- signs
- slotmachine
- stool_bed_chair_nest/bed
- vending
- watercloset
- wild
- turfs/flooring/floor_decal
- hooks
- modules
- 1713
- _mags1904
- _mags_energy
- _magsmodern
- apparel
- apparel_campaign
- apparel_coldwar
- apparel_earlymodern
- apparel_fallout
- apparel_medieval
- apparel_modern
- apparel_worldwars
- barriers/sandbag
- closets
- complex_production
- computers
- crates
- custom_apparel
- jobs
- machinery
- martial_arts/_martial
- medical
- modern_items
- natural_disasters
- production
- punishment
- radiation
- radio
- structures
- telegraph
- telephone
- tools
- weapons
- weather
- admin
- chat/chat
- client/preferencesSQLite/preference_setup
- magic
- multiz
- nano/_nanoui
- organs
- persistence/functions
- projectiles
- _ammo_casing
- effects
- projectile
- reagents
- 1713
- predefines
- processes/scheduler
Types
- (global)
- atom
- client - //////////VISION CONE///////////////
- datum - The absolute base class for everything
- admin_secret_category/admin_secrets - Pre-defined categories
- admin_secret_item/admin_secret - Pre-defined base items
- admins
- callback
- category_collection - Category Collection
- player_setup_collection - Category Collection Setup
- category_group - Category Groups
- player_setup_category - Category Category Setup
- category_item - Category Items
- player_setup_item - Category Item Setup
- client_preference
- admin
- show_chat_overlays - Player Preferences
- controller
- global_vars
- master
- Subsystem base class - Defines a subsystem to be managed by the Master Controller
- data/vending_product - Datum used to hold information about a product in a vending machine
- effect/effect/system/steam_trail_follow - Attach a steam trail to an object (eg. a reacting beaker) that will follow it
- email - DATUMS
- engine_config - Configuration for vehicle engines
- http_request
- job
- american - US - Vietnam War
- american_cop - Civilians
- atf_lieutenant - ATF
- captain_korean_war - KOREAN WAR
- coldwar/captain - /////////////////////////////////////////////Americans (1985)//////////////////////////////////////// ARMY
- fbi - FEDS & HVTs
- free_syrian_army - SYRIAN NATIONAL ARMY/FREE SYRIAN ARMY/REBELS
- hvt - VIPS
- idf - IDF
- sailor_ww2 - NAVY
- siberiad/commander - NATO/COALITION
- starwars/empire/lieutenant - EXTRA-GALACTIC EMPIRE
- usmc_lieutenant - MARINES (2000's)
- arab - ARABS
- civilian/chechen
- hezbollah/squad_leader - HEZBOLLAH
- insurgent_leader - INSURGENTS
- mujahideen/warchief - Mujahideen
- syrian_commander - SYRIAN CIVIL WAR
- british - BRITISH
- army_commander - ARMY
- civilian/governor - BRITISH
- medieval_lord - BRITISH
- ww1captain - WW1
- ww2lieutenant_pow - WW2
- chinese
- captain_korean - KOREAN WAR
- pla/captain - MODERN PLA
- sovcon/pla/commisar - Sino-Soviet Border Conflict
- civilian - CIVILIAN
- abashiri/prisoner - ABASHIRI PRISONERS
- wing1 - ABASHIRI PRISONERS
- afghan
- doctor - Afghan civilians
- dra
- governor - DRA Goverment
- lieutenant - DRA soldiers
- businessman - ART OF THE DEAL GAMEMODE
- chinese - 1930s Chinese Red Army/////////////// TO BE COMPLETED
- civa - CIVS
- confederate_captain - CONFEDERATE
- cult_leader - BRANCH DAVIDIANS
- fantasy - SPECIES
- mayor - PIONEERS
- outlaw - OUTLAWS
- prisoner - PRISONERS
- bagne_logger - PRISONERS
- ruhrunteroffizier - RUHR RED ARMY
- russian
- hvt - KGBS & SSMs
- sov_militia - MILITIAS
- skyrim/stormcloak/ulfric - STORMCLOAKS
- spanish - spanish civil war republicans
- unitednations/lieutenant - UN Troops
- us_militia - MILITIAS
- warlords - SECOND RACE 4 AND JOB FILES HEAD 2 HEAD AUTOBALANCE
- abashiri/prisoner - ABASHIRI PRISONERS
- danish/raven_clan - RAVEN CLAN
- filipino - FILIPINO
- french
- army_commander - ARMY
- civilian/governor - FRENCH
- crusader_lord - FRENCH//CRUSADERS
- medieval_lord - FRENCH
- ww1captain - WW1
- german
- captain_reichstag - WW2 Reichstag
- chieftain - Germanic Tribes
- hauptmann - WW2 NOT REICHSTAG
- occupation - GERMAN
- reichswehr_sergeant - WEIMAR REPUBLIC
- tank_crew_leader - TANKERS AND PANZERGRANADIERS
- volksturm_berlin - BERLIN ONLY
- warsaw_schutzpolizei - WARSAWUPRISING
- greek/squad_leader_ww2 - WW2
- indians
- ballas - BALLAS
- tribes/red - TRIBES//RP//STUFF
- warlords/tadojsville - TADOJSVILLE
- japanese
- abashiri/guard/warden - ABASHIRI
- ija_camp_director - WW2 JAPANESE PRISON
- ija_captain - WW2
- ija_sergeant_tanker - TANK CREW
- ijn_captain - NAVY
- western_lord - ICHI
- yakuza_underboss_ichi - ICHI
- norwegian/bear_clan - BEAR CLAN
- pirates - PIRATES
- battleroyale - BATTLE/ROYALE/STUFF
- polish/warsaw
- lead - WARSAWUPRISING
- redarmypolsl - Red army warsaw reinforcements
- portuguese/civilian/governor - PORTUGUESE
- roman - ROMAN
- gladiator - GLADIATOR
- skyrim/imperial/guard_captain - WHITERUN GARRISON
- russian
- captain_soviet - WW2
- coldwar/captain - Soviet army (1985's)
- nkvdborderley - 1941 Barbarossa
- rcw_captain - RUSSIAN/CIVIL/WAR
- rednikov/tatarin - DRUG BUST
- robber - BANK ROBBERY
- ruff_lieutenant - Russian Federal Forces
- siberiad/commander - SOVIET UNION
- sovafghan/captain - Soviet army (1985's)
- soviet_border/kgb_lt - Sino-Soviet Border Conflict
- tank_crew_leader - ww2 tankers
- spanish
- civilian/governor - SPANISH
- corpse/soldier - EXTRAS FOR CORPSES
- vietnamese/vietcong_officer_nva - VIETNAMESE NVA
- american - US - Vietnam War
- martial_art/the_sleeping_carp
- nanomanager
- nanoui
- program
- carspawn - MIL SIM CAR SPAWNER
- cartrader - CARTRADER MARKETPLACE
- deepnet - DEEPNET MARKETPLACE
- elektra - /////E-LEKTRA SHOP////////////// Where companies can get percursors
- junglebank - ///////////////////////JUNGLE BANK//////////////////////// For legitimate businessmen to deposit money and buy stocks
- nilestore - /////NILE.UG MARKETPLACE////// A legal shop for non-gun stuff
- platoontracker - TRACKING SYSTEM
- squadtracker - POLICE STUFF
- reagent/hydrogen - CHEMICAL ELEMENTS
- scheduled_task - Task Datum
- sortInstance
- spell
- burnus - Destruction (Expert Magic)
- freezum - Control & Chaos (Advanced Magic)
- painum - The "Naughty" Curses (Dark Arts)
- pushum - Force & Physics (Intermediate Magic)
- spark - Previously Existing Spells
- zappus - The Fundamentals (Beginner Magic)
- Timed Event - This is the actual timer, it contains the callback and necessary data to maintain the timer.
- vehicle_configuration - ///////////////////// MODULAR VEHICLES CONFIGURATION DATUMS //////////////////////// Defines configuration objects for vehicles, wheels, and walls. This replaces scattered vars and deep type hierarchies with composable data. Base configuration for a vehicle
- vehicle_constants
- vehicle_factory
- vehicle_template - Registry for premade vehicle configurations
- vehicle_walls - ///////////////////// VEHICLE WALL/ARMOR SYSTEM //////////////////////// Manages vehicle walls and armor panels with proper encapsulation. Replaces the old list-based system with proper datum objects. Manages all 4 sides of vehicle armor
- wall_config - Configuration for vehicle walls/armor
- wall_section - Individual wall section
- wheel_config - Configuration for wheels and tracks
- wound - WOUNDS
- hook
- death - Death hook. Called in death.dm when someone dies. Parameters: var/mob/living/human, var/gibbed
- roundend - Roundend hook. Called in gameticker.dm when a round ends.
- roundstart - Roundstart hook. Called in gameticker.dm when a round starts.
- startup - @file hooks.dm Implements hooks, a simple way to run code on pre-defined events.
- map_storage - MAP STORAGE DATUM
- mob/living
- human
- simple_animal
- chick - CHICKENS
- hostile/human
- voyage
- merchant - CIVIES
- pirate/ranged - mob/living/simple_animal/hostile/human/voyage/pirate/New()
- voyage
- turkey_f - TURKEYS
- obj
- covers
- effect
- decal/cleanable/blood/tracks
- effect/smoke - SMOKE SYSTEMS
- floor_decal
- corner_kafel - |
- corner_oldtile - |
- projectile
- impact/magic - Projectile Impacts
- laser/muzzle - LASERS
- tracer/magic - Projectile Tracers
- spawner/objspawner - OBJ SPAWNER
- door - DOOR SPAWNERS
- step_trigger/teleporter/stairs - TELEPORTER
- effects/premadevehicles
- apc - APCS
- car - CARS
- ship - SHIPS
- tank - TANKS
- truck - TRUCKS
- item
- ammo_casing
- musketball - XVIII CENTURY STUFF
- rocket - AMMO
- ammo_magazine
- c6belt - c6
- c762x38mmR - NAGANT REVOLVER
- mosin - RUSSO-JAPANESE WAR WEAPONS MAGS N AMMO
- tibannagas/qblz1 - other energy mags
- camera - camera
- camera_film - film
- clothing
- accessory
- armor/modern/lightplate - other
- storage/webbing/green_webbing
- blue - //////// Webbings /////////////////////// BLUE
- red - RED
- gloves/goalkeeper/red - GLOVES
- head
- caubeen - IRISH BERET
- custom/customberet - HATS
- custom_off_cap - WW2-MODERN
- helmet
- medieval/tes13/dwemmer - SKYRIM
- modern/mk6 - Russo-Ukraine war
- rebel - REBELS
- ww2 - WW2 JAPS
- ph_us_war/filipino - PHILIPPINE-AMERICAN WAR
- surgical_cap - SURGICAL CAPS
- top_hat - CIVILIAN STUFF
- ww2/britishoffcap - BRITISH
- mask/headscarfgrey
- shoes/football - SHOES
- suit/storage
- coat/tes13/fine_clothing - tes13 civilian
- jacket/customcolonialcoat - COLONIAL COAT
- under
- abashiri - ABASHIRI
- ballas1 - MAP SPECIFIC OBJECTS
- bodyglove - Majority of the Sprites under this is made by Mane from TGMC
- caf - CAF
- custom
- toga - ANCIENT
- tunic - MEDIEVAL
- customdress - IMPERIAL
- custompyjamas - CIVILIAN STUFF
- customtrackpants - Track suit
- customtribalrobe - CUSTOM TRIBAL
- customuniform - CUSTOM GENERIC UNIFORMS
- customuniform_modern - UNIFORMS
- customvicuniform - UNIFORMS
- fallout/legionaire - LEGION
- football/custom - CUSTOM JERSEY
- impstormofficer - Imperial Tunics and Caps
- japuni - RUSSO-JAP
- repensignofficer - Republic Tunics and Caps
- scrubs - MEDICAL SCRUBS
- spain/republican - spanish civil war
- tes13/stormcloak - whiterun/stormcloaks
- ww1/german - WW1 UNIFORMS
- ww2
- german - WW2
- upa - UPA
- us - UNITED STATES
- accessory
- garrote - GARROTE
- organ - INTERNAL ORGANS DEFINES
- projectile
- laser/b - LASERS
- shell
- autocannon - AUTOCANNON
- cannonball - CANNONBALL
- missile - GRENADE LAUNCHER
- sail - EXTRA STUFF
- stack
- component - components
- money
- fiat
- septim - SKYRIM
- precursor - //precursors components//
- vehicleparts
- frame - FRAME
- wheel - DRIVING WHEEL
- modular - DRIVING WHEELS
- weapon
- attachment
- bayonet - MISC ATTACHMENTS
- scope
- adjustable
- advanced - ADVANCED OPTICS
- sniper_scope
- apx - FRENCH
- m84 - AMERICAN
- pu - RUSSIAN
- type97 - JAPANESE
- zf39 - GERMAN
- iron_sights - OPTICS
- adjustable
- silencer - SILENCERS
- under - UNDER BARREL
- chicken_carcass - CHICKEN
- clay/mold - RAW MOLDS
- fired - FIRED MOLDS
- disk - DISKS
- os - OSes
- program - programs
- enginemaker - ENGINE MAKER
- grenade/smokebomb/signal - Signal Smoke
- gun
- launcher/grenade/underslung/m203 - LAUNCHERS
- projectile
- ancient - for fire lances, hand cannons, arquebuses
- automatic
- breda30 - Breda 30
- browning_lmg - M1919A6
- laser/qblz1 - other laser weapons
- manual - Manual Machine guns
- c6 - C6 GPMG
- mg13 - MG13
- nsv_utes - NSVT
- stationary/laser - STAT MG'S
- boltaction/berdan - //need to add: Springfield Model 1861,Pattern Volcanic Carbine, M1817 Common Rifle (All Rifles used during the civil war)
- capnball - cap n ball revolvers
- pistol/laser - PISTOLS
- revolving - Revolving Rifle
- submachinegun/m16/fallout/service_rifle - FALLOUT
- key
- eft/gate0 - Keys
- japanese/german
- lockpick - LOCKPICK
- material
- magic/wand/crafted
- sword
- longclaw - GAME OF THRONES
- tes13/twohanded - SKYRIM
- tes13/mace - SKYRIM
- paper/police/searchwarrant/drug - Objects and stuff
- personal_documents - PEPELSIBIRSK PERSONAL DOCUMENTS
- pigleg - PIGLEGS
- pill_pack - Pill Pack Define
- antitox - Pill Packs
- plough - Shovel
- radio - PORTABLE RADIOS
- walkietalkie - "POUCH SLOT" RADIOS
- reagent_containers
- dropper - Droppers.
- food - Food.
- condiment - Condiments
- drinks - Drinks.
- snacks
- cow - SALAMIMIMI
- hardtack - Snacks
- mince - MINCER
- pemmican - PEMMICAN
- sliceable - Sliceable Sliceable
- glass - (Mixing)Glass.
- barrel/modern
- bmilk - Galactic Battles
- yellow - yellow barrel
- barrel/modern
- nuclear
- controlrod
- fuelrod - nuclear shit
- meltedsomething
- notnuclear/uraniumref - not radioactive
- nuclearwastebarrel
- pill - Pills.
- antitox - Pills. END
- spray/chemsprayer - SPRAYER
- syringe/antitoxin - Syringes. END
- roulette/chip - Roulette
- shield/tes13 - SKYRIM
- storage
- belt
- russian - storage
- smallpouches
- blue - //////// Pouches /////////////////////// BLUE
- red - RED
- eft/medical - Medical
- envelope - ENVELOPE
- firstaid/ifak - Temp refactor of in-belt medkits
- photo_album - photo album
- belt
- telephone - TELEPHONE
- mobile - MOBILE PHONE
- weldingtool - WELDER
- attachment
- ammo_casing
- map_metadata
- battle_ships
- campaign
- capitol_hill/pla_offensive - CHINESE
- colonia
- nomads/wasteland
- three - Wasteland 3: Return of the Antman
- two - Wasteland 2: Electric Boogaloo
- omaha/micromaha - MICROMAHA
- pepelsibirsk
- pioneers/wasteland_two - Pioneer Wasteland 2
- smallsiegemoscow - SMALLSEIGE
- stalingrad/minigrad - MINIGRAD
- voyage
- random
- gun - Guns
- magazine - Magazines
- mine/ap - Barricades, Mines & Trees
- screen
- areashow - SCREEN HELPERS
- areashow_aod - SCREEN HELPERS
- noise - Screen effects
- spell
- fixae - Below Top Right (Row 14)
- freezum - Top Right Spells (Row 15)
- pushum - Below Top Left (Row 14)
- spellshow - SCREEN HELPERS
- structure
- altar
- darkstone
- sacrifice - map specific objs
- unsacrifice - map specific objs
- heads - Map Specific Objects
- darkstone
- assembler - assembler
- bakelizer - bakelizer (plastic maker)
- banner/faction - POSTERS, BANNERS, ETC
- basketball_hoop - BASKETBALL
- bed
- chair
- commander - COMMANDER CHAIR
- naval - COMMANDER NAVAL
- nvg - COMMANDER NVG
- thermal - COMMANDER THERMAL
- gunner - GUNNER
- loader - LOADER CHAIR
- sofa - sofa but actually a chair not a bed
- commander - COMMANDER CHAIR
- custsofa - Updated Sofa
- saving - SAVING BEDS
- sofa - sofa
- chair
- camonet - CAMONET
- cargo_container - CARGO CONTAINERS
- cell_tower - CELLPHONE TOWER
- chemical_dispenser
- closet
- crate
- abashiri/ammo - ABASHIRI
- airdrops/soviet/ammo - soviet resupplies
- grenades - WEAPONS
- wall_mailbox - MAILBOXES
- ww1/grenades_french - WW1
- hideout - Hide-outs
- crate
- cross - CRUCIFIXION
- cutting_board - CUTTING BOARD
- distillery - ETHANOL REFINERY
- drying_rack - LARGE/DEHYDRATOR
- engine
- external - EXTERNAL
- steam - ENGINES
- internal/hotbulb - ENGINES
- external - EXTERNAL
- fireplace_portal - FIREPLACE PORTAL
- fishing_cage - Crab Cage
- fountain - Fountains
- fuelpump - FUEL PUMP
- functions/clean_arena1 - CLEANERS
- furnace - Furnaces
- blast_furnace - ADVANCED METALLURGY STUFF
- kiln - ADVANCED METALLURGY STUFF
- gate/elevator_door - Pseudo-Elavators///// Currently designed for a 2x2 enclosed space, code needs to be overhauled in case we want bigger, more complex elevators (see about porting Baystation's turbolifts)
- gladiator_control - AUTO GLADIATOR CONTROL
- gladiator_ledger - Things related to gladiator mode: ledgers, match controls, beds for saving
- goalpost - GOALPOSTS
- grille/chainlinkfence - CHAIN-LINK FENCES
- door - CHAIN-LINK FENCE DOOR
- katana_stand - Katana Wall Stand
- kitchenspike - Kitchen Spike
- lamp - Mostly electrically powered stuff
- largecrate/smuggler - SMUGGLING SYSTEM
- machinery/water_pump - CONSTRUCTION PROPS
- mailbox - MAIL//SYSTEM
- money_printer
- multiz
- ladder - LADDER
- stairs/enter - Active
- oven/grill/gas - Following objects are grill or oven subtypes until proper cooking/kitchen mechanics will be implemented
- pepelsibirsk_radio - TRADING CODE ////// (it's my magnum opus -Terrariola)
- pillory - STOCK/PILLORY
- post_execution - EXECUTION POST
- printingpress - PRINTING/PRESS
- props
- junk - More Props
- piping/pipe - Pipes
- server - Props
- slot_machine - Slot machine
- radio - RADIO
- radiorecorder - RADIO RECORDER
- refinery/biofuel - BIOFUELS
- religious
- runestone/odinsgift - map specific objs
- statue - STATUES
- salting_container - SALTING CONTAINER
- sawmill - PLANKAGE////////////////SAWMILLS
- ship_bow - SHIP
- sign
- christmas/lights - CHRISTMAS
- map_board - MAP BOARD
- restroom - Restroom signs
- simple_door/key_door
- custom/jail/woodjail - obj/structure/simple_door/resin/New(var/newloc,var/material_name)
- eft/gate0 - Doors
- stockmarket
- submitter - TEAM CREATOR
- supplier
- torch_stand - TORCH STAND
- vehicle
- vehicleparts
- axis - /////////////////////////AXIS////////////////////////////
AXIS: MOVEMENT LOOP
AXIS: MOVEMENT LOOP
- car/piccolino - axis
- frame - FRAMES
- baf1_a - BAF-I A
- bradley - M2 Bradley
- car
- type94/lf - TYPE 94 TRUCK////////////////////////////////////////////// //////TYPE95 Kurogane
- type95/lf - TYPE95 Kurogane
- hago
- lb - back
- lc - middle
- lf - front
- i_go - JAPAN
- is2 - IS-2
- lb - back
- lbc - middle-back
- lf - front
- lfc - middle-front
- is3 - IS-3
- lb - back
- lbc - middle-back
- lc - middle
- lf - front
- lfc - middle-front
- m41 - M-41
- lb - back
- lc - middle
- lf - front
- ship/steel/lc13 - LC mod. XIII
- su100 - SU-100
- lb - back
- lbc - middle-back
- lf - front
- lfc - middle-front
- movement - ///////////////////// REFACTORED MOVEMENT SYSTEM ////////////////////////
Consolidated wheel and track implementation using wheel_config datums.
This replaces 50+ type definitions with a single parameterizable type.
- reversed
- sail - WHEELS AND TRACKS
- tracks - ///////////////////// MOVEMENT COMPATIBILITY TYPES //////////////////////// These are legacy movement paths used by premade vehicles and older vehicle definitions. They map onto the new config-driven movement system.
- shipwheel - WIP ship wheel
- axis - /////////////////////////AXIS////////////////////////////
AXIS: MOVEMENT LOOP
AXIS: MOVEMENT LOOP
- vending - A vending machine
- sales - A vending machine / market stall that actually charges per sale.
- cia_agent - Vendors
- market_stall - MARKET STALL AND VENDORS CUSTOM OBJECTS
- moneycounter - MONEY COUNTER
- sales - A vending machine / market stall that actually charges per sale.
- voyage - Specific objects
- wallclock - wallclock
- wild
- bush - Bushes
- palm - Palm Tree
- tree - Trees
- window/barrier
- incomplete - Dirt-bags
- sandbag/incomplete - Sand-bags
- altar
- process
- scheduler - Scheduler
- processScheduler
- turf/floor
- delivery - delivery points
- lava - Vulcano