diff --git a/_maps/map_files/IceMeta.html b/_maps/map_files/IceMeta.html index 096cc29c4e19..82a2d6d3b27e 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 61af7dd9aace..d1d169fb3917 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

@@ -82,31 +82,31 @@

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

canSmoothWithAreas - +

typecache to limit the areas that atoms in this area can smooth with, used for shuttles IIRC

contained_turfs - +

List of all turfs currently inside this area. Acts as a filtered bersion of area.contents For faster lookup (area.contents is actually a filtered loop over world) @@ -114,97 +114,97 @@

Var Details

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

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(mapload)

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

noteleport - +

Are you forbidden from teleporting to the area? (centcom, mobs, wizard, hand teleporter)

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

turfs_to_uncontain - +

Contained turfs is a MASSIVE list, 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 @@ -212,24 +212,24 @@

Var Details

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

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

@@ -238,7 +238,7 @@

Var Details

Call back when an atom enters an area

@@ -246,14 +246,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

@@ -262,32 +262,32 @@

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

PlaceOnTopReact

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

addStaticPower

Add a static amount of power load to an area

@@ -297,14 +297,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

@@ -312,33 +312,33 @@

Var Details

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

drop_location

Causes a runtime error

firealert

Generate an firealarm alert for this area

@@ -346,7 +346,7 @@

Var Details

Reset the firealarm alert for this area

@@ -355,27 +355,27 @@

Var Details

Returns TRUE if we have contained turfs, FALSE otherwise

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

@@ -383,13 +383,13 @@

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

@@ -399,35 +399,35 @@

Var Details

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

@@ -435,19 +435,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/shuttle.html b/area/shuttle.html index 0f8811a2bee4..f9859b7cdc93 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 c346859abbe9..64dbabc195af 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 8e54aba4d0f1..d8ef73da96bf 100644 --- a/atom.html +++ b/atom.html @@ -16,7 +16,7 @@

/atom - +

The base type for nearly all physical objects in SS13

@@ -208,104 +208,104 @@

Var Details

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

add_overlays - +

a very temporary list of overlays to add

age_restricted - +

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

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...

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.

buckle_message_cooldown - +

Cooldown tick timer for buckle messages

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

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

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. @@ -313,171 +313,171 @@

Var Details

HUD images that this atom can provide.

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_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.

priority_overlays - +

overlays that should remain on top and not normally removed when using cut_overlay functions, like c4.

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

remove_overlays - +

a very temporary list of overlays to remove

targeted_by - +

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

Proc Details

AllowDrop

Are you allowed to drop this atom

CanAllowThrough

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

@@ -489,7 +489,7 @@

Var Details

Top level of the destroy chain for most atoms

@@ -503,14 +503,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

@@ -519,33 +519,33 @@

Var Details

An atom has exited this atom's contents

Default behaviour is to send the COMSIG_ATOM_EXITED

GenerateTag

Generate a tag for this atom

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

@@ -575,7 +575,7 @@

Var Details

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

@@ -588,7 +588,7 @@

Var Details

Called when an atom is created in byond (built in engine proc)

@@ -599,57 +599,57 @@

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

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

@@ -662,48 +662,48 @@

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

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

check_eye

Return the air if we can analyze it 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

@@ -713,19 +713,19 @@

Var Details

Connect this atom to a shuttle

contents_explosion

Handle what happens when your contents are exploded by a bomb

contents_ui_distance

public

@@ -737,7 +737,7 @@

Var Details

Convenience proc to create a reagents holder for an atom

@@ -748,25 +748,25 @@

Var Details

Crowbar act

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

@@ -779,7 +779,7 @@

Var Details

React to an EMP of the given severity

@@ -789,14 +789,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

@@ -805,7 +805,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)

@@ -814,20 +814,20 @@

Var Details