diff --git a/_maps/map_files/IceMeta.html b/_maps/map_files/IceMeta.html index 1a1cf4dc8700..433f805a6d35 100644 --- a/_maps/map_files/IceMeta.html +++ b/_maps/map_files/IceMeta.html @@ -14,7 +14,7 @@

_maps/map_files/IceMeta/README.txt - +

@@ -24,7 +24,7 @@

_maps/map_files/IceMeta/README.txt

diff --git a/area.html b/area.html index 6cff272e2985..0c672f9a06a5 100644 --- a/area.html +++ b/area.html @@ -16,7 +16,7 @@

area - +

A grouping of tiles into a logical space, mostly used by map editors

@@ -101,152 +101,152 @@

Var Details

Wire assignment for airlocks in this area

ambient_buzz - +

Ambient buzz of the station, plays repeatedly, also IC

ambient_buzz_vol - +

The volume of the ambient buzz

area_has_base_lighting - +

Whether this area has a currently active base lighting, bool

area_limited_icon_smoothing - +

Typepath to limit the areas (subtypes included) that atoms in this area can smooth with. Used for shuttles.

base_lighting_alpha - +

alpha 0-255 of lighting_effect and thus baselighting intensity

base_lighting_color - +

The colour of the light acting on this area

daylight_multiplier - +

Daylight brightness

delta_light - +

a simple check to determine whether the lights in an area should go red during delta alert

fire - +

If true, that means one of any fire alarms in the area is active

hidden - +

Hides area from player Teleport function.

lighting_colour_bulb - +

The color of the light bulb's light in this area

lighting_colour_tube - +

The color of the light tubes' light in this area

lighting_effects - +

List of mutable appearances we underlay to show light In the form plane offset + 1 -> appearance to use

lights_always_start_on - +

Whether the lights in this area aren't turned off when it's empty at roundstart

map_generator - +

This datum, if set, allows terrain generation behavior to be ran on Initialize()

max_ambience_cooldown - +

Used to decide what the maximum time between ambience is

min_ambience_cooldown - +

Used to decide what the minimum time between ambience is

mood_bonus - +

Bonus mood for being in this area

mood_message - +

Mood message for being here, only shows up if mood_bonus != 0

safe - +

Is the area teleport-safe: no space / radiation / aggresive mobs / other dangers

show_on_sensors - +

If false, then this area will show up as gibberish on suit sensors.

sound_environment - +

Used to decide what kind of reverb the area makes sound have

static_lighting - +

Whether this area allows static lighting and thus loads the lighting objects

turfs_by_zlevel - +

List of all turfs currently inside this area as nested lists indexed by zlevel. Acts as a filtered version of area.contents For faster lookup @@ -255,7 +255,7 @@

Var Details

turfs_by_z_level can hold MASSIVE lists, so rather then adding/removing from it each time we have a problem turf We should instead store a list of turfs to REMOVE from it, then hook into a getter for it @@ -264,30 +264,30 @@

Var Details

If false, loading multiple maps with this area type will create multiple instances.

uses_daylight - +

Whether to cycle brightness based on time of day

xenobiology_compatible - +

Can the Xenobio management console transverse this area by default?

Proc Details

AllowDrop

Causes a runtime error

Destroy

Destroy an area and clean it up

@@ -296,7 +296,7 @@

Var Details

Call back when an atom enters an area

@@ -304,14 +304,14 @@

Var Details

Called when an atom exits an area

Sends signals COMSIG_AREA_EXITED and COMSIG_EXIT_AREA (to the atom)

Initialize

Initalize this area

@@ -320,26 +320,26 @@

Var Details

Sets machine power levels in the area

ModifyFiredoors

Try to close all the firedoors in the area

New

Called when an area loads

Adds the item to the GLOB.areas_by_type list based on area type

addStaticPower

Add a static amount of power load to an area

@@ -349,14 +349,14 @@

Var Details

Generate an atmospheric alert for this area

Sends to all ai players, alert consoles, drones and alarm monitor programs in the world

burglaralert

Raise a burglar alert for this area

@@ -364,45 +364,45 @@

Var Details

Ensures that the contained_turfs list properly represents the turfs actually inside us

cannonize_contained_turfs_by_zlevel

Ensures that the contained_turfs list properly represents the turfs actually inside us

clear_usage

Clear all power usage in area

Clears all power used for equipment, light and environment channels

close_and_lock_door

Close and lock a door passed into this proc

Does this need to exist on area? probably not

create_area_lighting_objects

regenerates lighting objects for turfs in this area, primary use is VV changes

drop_location

Causes a runtime error

firealert

Generate an firealarm alert for this area

@@ -410,7 +410,7 @@

Var Details

Reset the firealarm alert for this area

@@ -419,13 +419,13 @@

Var Details

Returns the highest zlevel that this area contains turfs for

get_original_area_name

Returns the name of an area, with the original name if the area name has been changed.

@@ -433,58 +433,58 @@

Var Details

Returns a list with all turfs in this zlevel.

get_turfs_from_all_zlevels

Merges a list containing all of the turfs zlevel lists from get_zlevel_turf_lists inside one list. Use get_zlevel_turf_lists() or get_turfs_by_zlevel() unless you need all the turfs in one list to avoid generating large lists

get_zlevel_turf_lists

Returns a nested list of lists with all turfs split by zlevel. only zlevels with turfs are returned. The order of the list is not guaranteed.

has_contained_turfs

Returns TRUE if we have contained turfs, FALSE otherwise

on_joining_game

Called when a living mob that spawned here, joining the round, receives the player client.

place_on_topReact

A hook so areas can modify the incoming args (of what??)

power_change

Called when the area power status changes

Updates the area icon and calls power change on all machinees in the area

poweralert

Generate a power alert for this area

Sends to all ai players, alert consoles, drones and alarm monitor programs in the world

powered

Returns int 1 or 0 if the area has power for the given channel

@@ -492,54 +492,54 @@

Var Details

If 100 ticks has elapsed, toggle all the firedoors closed again

reg_in_areas_in_z

Register this area as belonging to a z level

Ensures the item is added to the SSmapping.areas_in_z list for this z

remove_area_lighting_objects

Removes lighting objects from turfs in this area if we have them, primary use is VV changes

set_fire_alarm_effect

Trigger the fire alarm visual affects in an area

Updates the fire light on fire alarms in the area and sets all lights to emergency mode

setup

Setup an area (with the given name)

Sets the area name, sets all status var's to false and adds the area to the sorted area list

unset_fire_alarm_effects

unset the fire alarm visual affects in an area

Updates the fire light on fire alarms in the area and sets all lights to emergency mode

update_areasize

Set the area size of the area

This is the number of open turfs in the area contents, or FALSE if the outdoors var is set

update_icon_state

Update the icon state of the area

@@ -547,19 +547,19 @@

Var Details

Return the usage of power per channel

use_power

Add a power value amount to the stored used_x variables

diff --git a/area/holodeck.html b/area/holodeck.html index 9228f1724297..3e585b3211e9 100644 --- a/area/holodeck.html +++ b/area/holodeck.html @@ -16,7 +16,7 @@

Holodeck - +

Vars

@@ -25,12 +25,12 @@

Var Details

The holodeck computer that the area is being hosted by, which we use for power and such.

diff --git a/area/procedurally_generated.html b/area/procedurally_generated.html index 02de50db5eab..8ec05a120b8e 100644 --- a/area/procedurally_generated.html +++ b/area/procedurally_generated.html @@ -16,7 +16,7 @@

Dungeon - +

Vars

@@ -25,12 +25,12 @@

Var Details

- +

If there's other areas on the same z-level that share a generator, their turfs will be aggregated together into a combined working area

diff --git a/area/shuttle.html b/area/shuttle.html index 437e63769162..72f61263a817 100644 --- a/area/shuttle.html +++ b/area/shuttle.html @@ -16,7 +16,7 @@

Shuttle - +

Vars

@@ -25,12 +25,12 @@

Var Details

list of miners & their mining points from gems to be given once all exports are processed, used by supply shuttles

diff --git a/area/space.html b/area/space.html index b37e11af672d..78132fe02fc0 100644 --- a/area/space.html +++ b/area/space.html @@ -16,7 +16,7 @@

/area/space - +

Vars

@@ -24,19 +24,19 @@

/area/space

Procs

update_icon_stateUpdate the icon of the area (overridden to always be null for space

Proc Details

powered

Space is not powered ever, so this returns 0

update_icon_state

Update the icon of the area (overridden to always be null for space

diff --git a/atom.html b/atom.html index 9f733a5a7f12..049bc3e7ff51 100644 --- a/atom.html +++ b/atom.html @@ -16,7 +16,7 @@

/atom - +

The base type for nearly all physical objects in SS13

@@ -262,152 +262,152 @@

Var Details

all of this atom's HUD images which can actually be seen by players with that hud

age_restricted - +

Whether spessmen with an ID with an age below AGE_MINOR (21 by default) can buy this item

armor - +

Armor datum used by the atom

article - +

If non-null, overrides a/an/some in all cases

atom_colours - +

used to store the different colors on an atom

its inherent color, the colored paint applied on it, special color effect etc...

atom_integrity - +

Current integrity, defaults to max_integrity on init

base_icon_state - +

the base icon state used for anything that changes their icon state.

base_pixel_x - +

Default pixel x shifting for the atom's icon.

base_pixel_y - +

Default pixel y shifting for the atom's icon.

bottom_left_corner - +

Smoothing variable

bottom_right_corner - +

Smoothing variable

buckle_message_cooldown - +

Cooldown tick timer for buckle messages

canSmoothWith - +

List of smoothing groups this atom can smooth with. If this is null and atom is smooth, it smooths only with itself. Must be sorted.

can_atmos_pass - +

Check if atmos can pass in this atom (ATMOS_PASS_YES, ATMOS_PASS_NO, ATMOS_PASS_DENSITY, ATMOS_PASS_PROC)

custom_materials - +

The custom materials this atom is made of, used by a lot of things like furniture, walls, and floors (if I finish the functionality, that is.)

custom_premium_price - +

Economy cost of item in premium vendor

custom_price - +

Economy cost of item

damage_deflection - +

Damage under this value will be completely ignored

demo_last_appearance - +

Last appearance of the atom for demo saving purposes

explosion_block - +

Value used to increment ex_act() if reactionary_explosions is on

fingerprintslast - +

Last fingerprints to touch this atom

flags_1 - +

First atom flags var

greyscale_colors - +

A string of hex format colors to be used by greyscale sprites, ex: "#0054aa#badcff"

greyscale_config - +

The config type to use for greyscaled sprites. Both this and greyscale_colors must be assigned to work.

hud_list - +

all of this atom's HUD (med/sec, etc) images. Associative list of the form: list(hud category = hud image or images for that category). most of the time hud category is associated with a single image, sometimes its associated with a list of images. @@ -415,191 +415,191 @@

Var Details

HUD images that this atom can provide.

integrity_failure - +

Integrity level when this atom will "break" (whatever that means) 0 if we have no special broken behavior, otherwise is a percentage of at what point the atom breaks. 0.5 being 50%

interaction_flags_atom - +

Intearaction flags

light - +

Our light source. Don't fuck with this directly unless you have a good reason!

light_angle - +

Angle of light to show in light_dir 360 is a circle, 90 is a cone, etc.

light_color - +

Hexadecimal RGB string representing the colour of the light. White by default.

light_dir - +

What angle to project light in

light_flags - +

Bitflags to determine lighting-related atom properties.

light_height - +

How many tiles "up" this light is. 1 is typical, should only really change this if it's a floor light

light_on - +

Boolean variable for toggleable lights. Has no effect without the proper light_system, light_range and light_power values.

light_power - +

Intensity of the light. The stronger, the less shadows you will see on the lit area.

light_range - +

Range of the light in tiles. Zero means no light.

light_sources - +

Any light sources that are "inside" of us, for example, if src here was a mob that's carrying a flashlight, that flashlight's light source would be part of this list.

light_system - +

Light systems, both shouldn't be active at the same time.

managed_overlays - +

overlays managed by update_overlays to prevent removing overlays that weren't added by the same proc. Single items are stored on their own, not in a list.

managed_vis_overlays - +

vis overlays managed by SSvis_overlays to automaticaly turn them like other overlays

material_flags - +

Bitfield for how the atom handles materials.

max_integrity - +

Maximum integrity

proximity_monitor - +

Proximity monitor associated with this atom

rad_insulation - +

Radiation insulation types

reagents - +

Reagents holder

realized_overlays - +

List of overlay "keys" (info about the appearance) -> mutable versions of static appearances Drawn from the overlays list

realized_underlays - +

List of underlay "keys" (info about the appearance) -> mutable versions of static appearances Drawn from the underlays list

smoothing_flags - +

Icon-smoothing behavior.

smoothing_groups - +

What smoothing groups does this atom belongs to, to match canSmoothWith. If null, nobody can smooth with it. Must be sorted.

smoothing_junction - +

What directions this is currently smoothing with. IMPORTANT: This uses the smoothing direction flags as defined in icon_smoothing.dm, instead of the BYOND flags.

targeted_by - +

Mobs that are currently do_after'ing this atom, to be cleared from on Destroy()

top_left_corner - +

Smoothing variable

top_right_corner - +

Smoothing variable

update_on_z - +

Lazylist of all images (or atoms, I'm sorry) (hopefully attached to us) to update when we change z levels You will need to manage adding/removing from this yourself, but I'll do the updating for you

update_overlays_on_z - +

Lazylist of all overlays attached to us to update when we change z levels You will need to manage adding/removing from this yourself, but I'll do the updating for you @@ -607,18 +607,18 @@

Var Details

any atom that uses integrity and can be damaged must set this to true, otherwise the integrity procs will throw an error

Proc Details

AllowDrop

Are you allowed to drop this atom

Beam

This is what you use to start a beam. Example: origin.Beam(target, args). Store the return of this proc if you don't set maxdist or time, you need it to delete the beam.

@@ -632,25 +632,25 @@

Var Details

Returns true or false to allow the mover to move through src

CanPass

Can the mover object pass this atom, while heading for the target turf

CheckExit

Are you allowed to pass a sided object of the same dir

CheckParts

Ensure a list of atoms/reagents exists inside this atom

@@ -662,7 +662,7 @@

Var Details

Top level of the destroy chain for most atoms

@@ -676,14 +676,14 @@

Var Details

An atom has entered this atom's contents

Default behaviour is to send the COMSIG_ATOM_ENTERED

Exit

An atom is attempting to exit this atom's contents

@@ -692,27 +692,27 @@

Var Details

An atom has exited this atom's contents

Default behaviour is to send the COMSIG_ATOM_EXITED

HandleTurfChange

called when the turf the atom resides on is ChangeTurfed

Default behaviour is to loop through atom contents and call their HandleTurfChange() proc

HasProximity

Is this atom within 1 tile of another atom

Initialize

The primary method that objects are setup in SS13 with

@@ -745,7 +745,7 @@

Var Details

Late Intialization, for code that should run after all atoms have run Intialization

@@ -757,7 +757,7 @@

Var Details

Sends a signal that the new atom src, has been created at loc @@ -768,13 +768,13 @@

Var Details

Removes the specified invisibility source from the tracker

SetInvisibility

Sets invisibility according to priority. @@ -782,7 +782,7 @@

Var Details

Proc called when you want the atom to spin around the center of its icon (or where it would be if its transform var is translated) @@ -797,82 +797,82 @@

Var Details

Passes Stat Browser Panel clicks to the game and calls client click on an atom

acid_act

Respond to acid being used on our atom

Default behaviour is to send COMSIG_ATOM_ACID_ACT and return

add_atom_colour

Adds an instance of colour_type to the atom's atom_colours list

add_emitter

ATOM PROCS priority is in descending order so 10 is the highest 1 is the lowest

add_mob_blood

to add blood from a mob onto something, and transfer their dna info

analyzer_act

Analyzer act

assume_air

Take air from the passed in gas mixture datum

atom_break

Called after the atom takes damage and integrity is below integrity_failure level

atom_destruction

what happens when the atom's integrity reaches zero.

atom_fix

Called when integrity is repaired above the breaking point having been broken before

attack_hand_secondary

When the user uses their hand on an item while holding right-click Returns a SECONDARY_ATTACK_* value.

attack_hulk

This atom has been hit by a hulkified mob in hulk mode (user)

audible_message

Show a message to all mobs in earshot of this atom

@@ -885,60 +885,60 @@

Var Details

Creates text that will float from the atom upwards to the viewer.

balloon_alert_to_viewers

Create balloon alerts (text that floats up) to everything within range. Will only display to people who can see.

balloon_or_message

Creates a balloon alert, or sends a chat message dependant on client preferences. Args: viewer - mob that gets message/alert, alert - balloon alert text, message - text message that the mob gets if the preference is toggled, equals to alert message if not passed in the proc

bitmask_smooth

Basic smoothing proc. The atom checks for adjacent directions to smooth with and changes the icon_state based on that.

Returns the previous smoothing_junction state so the previous state can be compared with the new one after the proc ends, and see the changes, if any.

blob_act

React to a hit by a blob objecd

default behaviour is to send the COMSIG_ATOM_BLOB_ACT signal

bullet_act

React to a hit by a projectile object

Default behaviour is to send the COMSIG_ATOM_BULLET_ACT and then call on_hit() on the projectile

calculate_adjacencies

Scans all adjacent turfs to find targets to smooth with.

check_eye

Check if this atoms eye is still alive (probably)

component_storage_contents_dump_act

Implement the behaviour for when a user click drags another storage item to you

@@ -948,25 +948,25 @@

Var Details

Connect this atom to a shuttle

contains_atom

Checks if an atom is inside another atom. Significantly faster than iterating through all the mob's contents.

contents_explosion

Handle what happens when your contents are exploded by a bomb

contents_ui_distance

public

@@ -978,7 +978,7 @@

Var Details

Convenience proc to create a reagents holder for an atom

@@ -989,31 +989,31 @@

Var Details

Crowbar act

do_alert_animation

Does the MGS ! animation

do_spin_animation

Animates source spinning around itself. For docmentation on the args, check atom/proc/SpinAnimation()

drop_location

Where atoms should drop if taken from this atom

emag_act

Respond to an emag being used on our atom

@@ -1026,7 +1026,7 @@

Var Details

React to an EMP of the given severity

@@ -1036,14 +1036,14 @@

Var Details

React to being hit by an explosion

Default behaviour is to call contents_explosion() and send the COMSIG_ATOM_EX_ACT signal

examine

Called when a mob examines (shift click or verb) this atom

@@ -1052,7 +1052,7 @@

Var Details

Called when a mob examines (shift click or verb) this atom twice (or more) within EXAMINE_MORE_WINDOW (default 1.5 seconds)

@@ -1061,39 +1061,39 @@

Var Details