diff --git a/area.html b/area.html index 536010b12925..ed196c433baa 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

@@ -87,97 +87,97 @@

Var Details

Alarm type to count of sources. Not usable for ^ because we handle fires differently

airalarms - +

A list of all air alarms in this area

airlock_wires - +

Wire assignment for airlocks in this area

always_unpowered - +

This gets overridden to 1 for space in area/.

ambient_buzz - +

The background droning loop that plays 24/7

ambient_buzz_vol - +

The volume of the ambient buzz

ambientsounds - +

A list of sounds to pick from every so often to play to clients.

area_has_base_lighting - +

Whether this area has a currently active base lighting, bool

area_lighting - +

What type of lighting this area uses

area_limited_icon_smoothing - +

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

areasize - +

Size of the area in open turfs, only calculated for indoors areas.

base_lighting_alpha - +

alpha 1-255 of lighting_effect and thus baselighting intensity. If you want this to be zero, use AREA_LIGHTING_NONE instead!

base_lighting_color - +

The colour of the light acting on this area

beauty - +

Beauty average per open turf in the area

beauty_threshold - +

If a room is too big it doesn't have beauty.

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

Var Details

A var for whether the area allows for detecting fires/etc. Disabled or enabled at a fire alarm.

firealarms - +

A list of all fire alarms in this area OR ADJACENT TO IT

firedoors - +

A list of all fire locks in this area and on the border of this area.

forced_ambience - +

Does this area immediately play an ambience track upon enter?

lighting_effect - +

The mutable appearance we underlay to show light

lights - +

All the lights in this area

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

outdoors - +

For space, the asteroid, etc. Used with blueprints or with weather to determine if we are adding a new area (vs editing a station room)

requires_power - +

Will objects this area be needing power?

sound_environment - +

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

spook_level - +

Used by ghosts to grant new powers. See /datum/component/spook_factor

totalbeauty - +

All beauty in this area combined, only includes indoor area.

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 There is a risk of this and contained_turfs leaking, so a subsystem will run it down to 0 incrementally if it gets too large

Proc Details

AllowDrop

Causes a runtime error

Destroy

Destroy an area and clean it up

@@ -291,7 +291,7 @@

Var Details

Call back when an atom enters an area

@@ -299,33 +299,33 @@

Var Details

Called when an atom exits an area

Sends signals COMSIG_AREA_EXITED and COMSIG_EXIT_AREA (to a list of atoms)

LateInitialize

Sets machine power levels 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

@@ -335,13 +335,13 @@

Var Details

Adjusts the spook level and sends out a signal

burglaralert

Raise a burglar alert for this area

@@ -349,70 +349,70 @@

Var Details

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

clear_usage

Clear all non-static power usage in area

Clears all power used for the dynamic 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

communicate_fire_alert

Called by airalarms and firealarms to communicate the status of the area to relevant machines

create_area_lighting_objects

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

drop_location

Causes a runtime error

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.

play_ambience + +

Attempts to play an ambient sound to a mob, returning the cooldown in deciseconds

power_change

Called when the area power status changes

Updates the area icon, calls power change on all machinees in the area, and sends the COMSIG_AREA_POWER_CHANGE signal.

powered

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

@@ -420,14 +420,14 @@

Var Details

Register this area as belonging to a z level

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

removeStaticPower

Remove a static amount of power load to an area

@@ -437,39 +437,39 @@

Var Details

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

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

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_beauty

Divides total beauty in the room by roomsize to allow us to get an average beauty per tile.

use_power

Add a power value amount to the stored used_x variables

diff --git a/area/space.html b/area/space.html index 9c0c3e94f502..683eb271a4de 100644 --- a/area/space.html +++ b/area/space.html @@ -16,7 +16,7 @@

space - +

Vars

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

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 false

update_icon_state

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

diff --git a/area/station/ai_monitored/turret_protected.html b/area/station/ai_monitored/turret_protected.html index b400ebdbdad5..e643803033c6 100644 --- a/area/station/ai_monitored/turret_protected.html +++ b/area/station/ai_monitored/turret_protected.html @@ -16,7 +16,7 @@

turret_protected - +

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

Var Details

Some sounds (like the space jam) are terrible when on loop. We use this varaible to add it to other AI areas, but override it to keep it from the AI's core.

diff --git a/area/station/maintenance.html b/area/station/maintenance.html index 8bc3a27944b1..a70c6a6035cf 100644 --- a/area/station/maintenance.html +++ b/area/station/maintenance.html @@ -16,8 +16,8 @@

maintenance - -

+ +

Vars

Vars

minecraft_cave_noisesA list of rare sound effects to fuck with players.
@@ -25,12 +25,12 @@

Var Details

+ +

A list of rare sound effects to fuck with players.

diff --git a/atom.html b/atom.html index 5268c83248ec..4de3f8d3f9a1 100644 --- a/atom.html +++ b/atom.html @@ -16,7 +16,7 @@

atom - +

The base type for nearly all physical objects in SS13

@@ -336,196 +336,196 @@

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

ai_controller - +

AI controller that controls this atom. type on init, then turned into an instance during runtime. Note: If you are for some reason giving this to a non-mob, it needs to create it's own in Initialize()

armor - +

Atom armor. Use returnArmor()

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_storage - +

the datum handler for our contents - see create_storage() for creation method

base_icon_state - +

Used for changing icon states for different base sprites.

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_astar_pass - +

How this atom should react to having its astar blocking checked

chat_color - +

Last color calculated for the the chatmessage overlays

chat_color_darkened - +

A luminescence-shifted value of the last color calculated for chatmessage overlays

chat_color_name - +

Last name used to calculate a color for the chatmessage overlays

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.) The list referenced by this var can be shared by multiple objects and should not be directly modified. Instead, use set_custom_materials.

damage_deflection - +

Damage under this value will be completely ignored

debris_amount - +

Amount of debris particles

debris_icon_state - +

Icon state of debris when impacted by a projectile

debris_scale - +

Scale of particle debris

debris_velocity - +

Velocity of debris particles

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

flags_2 - +

Second atom flags var

forensics - +

Forensics datum, initialzed when needed.

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. @@ -533,216 +533,216 @@

Var Details

HUD images that this atom can provide.

in_atom_huds - +

A list of atom huds this object is within

initialized - +

Has this atom's constructor ran?

interaction_flags_atom - +

Intearaction flags

is_mouseover_interactable - +

!DO NOT DIRECTLY EDIT! Can mobs "interact" with this item? THIS IS ONLY USED FOR MOUSE ICONS. SEE interactables.dm.

light - +

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

light_color - +

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

light_falloff_curve - +

Adjusts curve for falloff gradient

light_flags - +

Bitflags to determine lighting-related atom properties.

light_inner_range - +

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

light_on - +

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

light_outer_range - +

Range where light begins to taper into darkness in tiles.

light_power - +

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

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.

material_modifier - +

Modifier that raises/lowers the effect of the amount of a material, prevents small and easy to get items from being death machines.

mergers - +

Holds merger groups currently active on the atom. Do not access directly, use GetMergeGroup() instead.

orbit_target - +

Reference to atom being orbited

pass_flags_self - +

pass_flags that we are. If any of this matches a pass_flag on a moving thing, by default, we let them through.

rad_insulation - +

Radiation insulation types

reagents - +

Reagents holder

receive_ricochet_chance_mod - +

When a projectile tries to ricochet off this atom, the projectile ricochet chance is multiplied by this

receive_ricochet_damage_coeff - +

When a projectile ricochets off this atom, it deals the normal damage * this modifier to this atom

remove_overlays - +

a very temporary list of overlays to remove

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.

top_left_corner - +

Smoothing variable

top_right_corner - +

Smoothing variable

uses_integrity - +

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

AltClickNoInteract

Use this instead of /mob/proc/AltClickOn where you only want turf content listing without additional atom alt-click interaction

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.

@@ -756,8 +756,8 @@

Var Details

This proc is used for telling whether something can pass by this atom in a given direction, for use by the pathfinding system.

Trying to generate one long path across the station will call this proc on every single object on every single tile that we're seeing if we can move through, likely @@ -772,25 +772,25 @@

Var Details

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

CanMoveOnto

A version of CanPass() that accounts for vertical movement.

CanPass

Whether the mover object can avoid being blocked by this atom, while arriving from (or leaving through) the border_dir.

CheckParts

Ensure a list of atoms/reagents exists inside this atom

@@ -802,7 +802,7 @@

Var Details

Before anything else, defer these calls to a per-mobtype handler. This allows us to @@ -812,7 +812,7 @@

Var Details

Top level of the destroy chain for most atoms

@@ -826,46 +826,46 @@

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

Default behaviour is to send the COMSIG_ATOM_EXIT

Exited + +

An atom has exited this atom's contents

Default behaviour is to send the COMSIG_ATOM_EXITED

GetExplosionBlock + +

returns how much the object blocks an explosion. Used by subtypes.

GetMergeGroup + +

Gets a merger datum representing the connected blob of objects in the allowed_types argument

HasProximity

Is this atom within 1 tile of another atom

Initialize

The primary method that objects are setup in SS13 with

@@ -898,13 +898,13 @@

Var Details

Is the atom obscured by a PREVENT_CLICK_UNDER_1 object above it

LateInitialize

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

@@ -916,7 +916,7 @@

Var Details

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

@@ -926,50 +926,50 @@

Var Details

Perform a shake on an atom, resets its position afterwards

ShowProcessingGui + +

Creates the radial and processes the selected option

Topic + +

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

_Click

stupid workaround for byond not recognizing the /atom/Click typepath for the queued click callbacks

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_blood_DNA

Returns TRUE if new blood dna was added.

add_context

Creates a "Type-B" contextual screentip interaction. @@ -982,103 +982,103 @@

Var Details

Add a list of fibers

add_fibers

Adds the fibers of M to our fiber list.

add_fingerprint

Adds the fingerprint of M to our fingerprint list. Ignoregloves will ignore any gloves they may be wearing.

add_fingerprint_list

Add a list of fingerprints

add_gunshot_residue

Add a list of residues

add_mob_blood

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

airflow_hit_act

Called when "flying" calls airflow_hit() on src

alt_click_on_secondary

The base proc of when something is right clicked on when alt is held - generally use alt_click_secondary instead

alt_click_secondary

The base proc of when something is right clicked on when alt is held

analyzer_act + +

Called on an object when a tool with analyzer capabilities is used to left click an object

analyzer_act_secondary + +

Called on an object when a tool with analyzer capabilities is used to right click an object

assume_air

Take air from the passed in gas mixture datum

atmos_expose

This is your process() proc

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_ai_secondary

What happens when the AI holds right-click on an item. Returns a SECONDARY_ATTACK_* value.

@@ -1089,13 +1089,13 @@

Var Details

Defaults to attack_hand or attack_hand_secondary. Override it when you don't want drones to do same stuff as humans.

attack_grab

Interaction handler for being clicked on with a grab. This is called regardless of user intent.

@@ -1108,32 +1108,32 @@

Var Details

Return TRUE to cancel other attack hand effects that respect it. Modifiers is the assoc list for click info such as if it was a right click.

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)

attack_paw

Attacked by monkey

attack_robot_secondary

What happens when the cyborg without active module holds right-click on an item. Returns a SECONDARY_ATTACK_* value.

@@ -1144,7 +1144,7 @@

Var Details

Telekinesis item attack_self act.

@@ -1156,7 +1156,7 @@

Var Details

Telekinesis attack act, happens when the TK user clicks on a non-adjacent target in range.

@@ -1167,7 +1167,7 @@

Var Details

Called on an object being hit by an item

@@ -1180,7 +1180,7 @@

Var Details

Connect this atom to a shuttle

container_resist_act + +

Called when something resists while this atom is its loc

contains

Returns true if the src countain the atom target

contents_explosion

Handle what happens when your contents are exploded by a bomb

create_forensics

Creates our forensics datum

create_reagents

Convenience proc to create a reagents holder for an atom

@@ -1329,56 +1329,56 @@

Var Details

A quick and easy way to create a storage datum for an atom

crowbar_act + +

Called on an object when a tool with crowbar capabilities is used to left click an object

crowbar_act_secondary + +

Called on an object when a tool with crowbar capabilities is used to right click an object

cut_overlays

Tracks the current index into build_overlays so that we can preserve ordering.

do_alert_animation

Does the MGS ! animation

do_hurt_animation

Plays an animation for getting hit.

drop_location + +

Where atoms should drop if taken from this atom

emag_act

Respond to an emag being used on our atom

Default behaviour is to send COMSIG_ATOM_EMAG_ACT and return

emp_act

React to an EMP of the given severity

@@ -1388,7 +1388,7 @@

Var Details

React to being hit by an explosion

@@ -1397,7 +1397,7 @@

Var Details

Returns the material composition of the atom.

Used when recycling items, specifically to turn alloys back into their component mats.

@@ -1599,46 +1599,46 @@

Var Details

Returns a list of mechanics information for this object.

get_name_chaser

Used to insert text after the name but before the description in examine()

get_remote_view_fullscreens

the vision impairment to give to the mob whose perspective is set to that atom

(e.g. an unfocused camera giving you an impaired vision when looking through it)

handle_atom_del

This proc is called when an atom in our contents has it's Destroy called

Default behaviour is to simply send COMSIG_ATOM_CONTENTS_DEL

handle_fall

Used for making a sound when a mob involuntarily falls into the ground.

handle_slip

Handle the atom being slipped over

has_gravity + +

Returns true if this atom has gravity for the passed in turf

Sends signals COMSIG_ATOM_HAS_GRAVITY and COMSIG_TURF_HAS_GRAVITY, both can force gravity with @@ -1659,8 +1659,8 @@

Var Details

Fetches a list of all of the materials this object has with the desired material category.

Arguments:

@@ -1673,8 +1673,8 @@

Var Details

Fetches a list of all of the materials this object has of the desired type. Returns null if there is no valid materials of the type

Arguments:

@@ -1685,13 +1685,13 @@

Var Details

What atom is actually "Hearing".

hitby

React to being hit by a thrown object

@@ -1702,63 +1702,63 @@

Var Details

We have have actually hit the passed in atom

Default behaviour is to move back from the item that hit us

hulk_damage

Called to get the damage that hulks will deal to the atom.

in_contents_of

Return true if we're inside the passed in atom

is_drainable

Is this atom drainable of reagents

is_drawable

Can we draw from this atom with an injectable atom

is_injectable

Is this atom injectable into other atoms

is_open_container

Convenience proc to see if a container is open for chemistry handling

is_refillable

Can this atoms reagents be refilled

isinspace

Is this atom in space

log_message + +

Generic logging helper

reads the type of the log @@ -1773,8 +1773,8 @@

Var Details

Helper for logging chat messages or other logs with arbitrary inputs(e.g. announcements)

This proc compiles a log string by prefixing the tag to the message @@ -1790,32 +1790,32 @@

Var Details

For admins. Logs when mobs players with this thing.

lose_atmos_sensitivity

removes temperature sensitivity

makeHologram + +

Makes this atom look like a "hologram" So transparent, blue and with a scanline

mat_update_desc

This proc is called when a material updates an object's description

mech_melee_attack

Mech melee attack @@ -1829,38 +1829,38 @@

Var Details

changes max_integrity while retaining current health percentage, returns TRUE if the atom got broken.

multitool_act + +

Called on an object when a tool with multitool capabilities is used to left click an object

multitool_act_secondary + +

Called on an object when a tool with multitool capabilities is used to right click an object

multitool_check_buffer + +

Check if the multitool has an item in it's data buffer

narsie_act

Respond to narsie eating our atom

Default behaviour is to send COMSIG_ATOM_NARSIE_ACT and return

ninjadrain_act

Atom level proc for space ninja's glove interactions.

@@ -1874,7 +1874,7 @@

Var Details

Is the atom in an away mission

@@ -1882,7 +1882,7 @@

Var Details

Is this atom currently located on centcom

@@ -1892,7 +1892,7 @@

Var Details

Is the atom in any of the centcom syndicate areas

@@ -1900,48 +1900,48 @@

Var Details

Called when the atom log's in or out

Default behaviour is to call on_log on the location this atom is in

on_mouse_enter + +

Fired whenever this atom is the most recent to be hovered over in the tick. Preferred over MouseEntered if you do not need information such as the position of the mouse. Especially because this is deferred over a tick, do not trust that client is not null.

play_attack_sound

the sound played when the atom is damaged.

prepare_huds

Prepare the huds for this atom

Goes through hud_possible list and adds the images to the hud_list variable (if not already cached)

rcd_act

Respond to an RCD acting on our item

Default behaviour is to send COMSIG_ATOM_RCD_ACT and return FALSE

rcd_vals

Return the values you get when an RCD eats you?

register_context

Create a "Type-B" contextual screentip interaction, registering to add_context(). @@ -1950,7 +1950,7 @@

Var Details

A special case of relaymove() in which the person relaying the move may be "driving" this atom

@@ -1959,7 +1959,7 @@

Var Details

An atom we are buckled or is contained within us has tried to move

@@ -1967,149 +1967,149 @@

Var Details

Reset plane and layer values to their defaults.

returnArmor

Retreive an atom's armor, creating it if it doesn't exist

return_air

Return the current air environment in this atom

return_analyzable_air

Return the air if we can analyze it

return_breathable_air

Return air that a contained mob will be breathing.

return_temperature + +

Return atom temperature

run_atom_armor

returns the damage value of the attack after processing the atom's various armor protections

runechat_prefs_check

Returns the client runechat visible messages preference according to the message type.

rust_heretic_act + +

Causes effects when the atom gets hit by a rust effect from heretics

Override this if you want custom behaviour in whatever gets hit by the rust

screwdriver_act + +

Called on an object when a tool with screwdriver capabilities is used to left click an object

screwdriver_act_secondary + +

Called on an object when a tool with screwdriver capabilities is used to right click an object

setArmor

Setter for armor

setClosed + +

Used to set something as 'closed' if it's being used as a supplypod

Override this if you want an atom to be usable as a supplypod.

setDir

Hook for running code when a dir change occurs

Not recommended to use, listen for the COMSIG_ATOM_DIR_CHANGE signal instead (sent by this proc)

setOpened + +

Used to set something as 'open' if it's being used as a supplypod

Override this if you want an atom to be usable as a supplypod.

set_base_pixel_x + +

Setter for the base_pixel_x variable to append behavior related to its changing.

set_base_pixel_y + +

Setter for the base_pixel_y variable to append behavior related to its changing.

set_custom_materials + +

Sets the custom materials for an item.

set_density + +

Setter for the density variable to append behavior related to its changing.

set_greyscale

Handles updates to greyscale value updates. @@ -2117,7 +2117,7 @@

Var Details

set every hud image in the given category active so other people with the given hud can see it. @@ -2130,55 +2130,55 @@

Var Details

sets every hud image in the given category inactive so no one can see it

set_hud_image_vars

Update the icon_state of an atom hud image.

set_light_color

Setter for the light color of this atom.

set_light_curve

Setter for this atom's light falloff curve.

set_light_flags

Setter for the light flags of this atom.

set_light_on

Setter for whether or not this atom's light is on.

set_light_power

Setter for the light power of this atom.

set_light_range

Setter for the light range of this atom.

set_opacity

Updates the atom's opacity value.

@@ -2186,70 +2186,70 @@

Var Details

Changes the icon state based on the new junction bitmask. Returns the old junction value.

shuttleRotate

Base proc

singularity_act

Respond to the singularity eating this atom

singularity_pull

Respond to the singularity pulling on us

Default behaviour is to send COMSIG_ATOM_SING_PULL and return

smooth_icon

do not use, use QUEUE_SMOOTH(atom)

take_damage

The essential proc to call when an atom must receive damage of any kind.

tool_act + +

Tool behavior procedure. Redirects to tool-specific procs by default.

You can override it to catch all tool interactions, for use in complex deconstruction procs.

Must return parent proc ..() in the end if overridden

transfer_mob_blood_dna

to add a mob's dna info into an object's blood_dna list.

unsafe_return_air

Return the current air environment in this atom. If this atom is a turf, it will not automatically update the zone.

update_above

Updates whatever openspace objects may be mimicking us. On turfs this queues an openturf update on the above openturf, on movables this updates their bound movable (if present). Meaningless on any type other than /turf or /atom/movable (incl. children).

update_appearance

Updates the appearence of the icon

@@ -2260,69 +2260,69 @@

Var Details

Resets the atom's color to null, and then sets it to the highest priority colour available

update_desc

Updates the description of the atom

update_greyscale

Checks if this atom uses the GAGS system and if so updates the icon

update_icon

Updates the icon of the atom

update_icon_state

Updates the icon state of the atom

update_integrity

Handles the integrity of an atom changing. This must be called instead of changing integrity directly.

update_light

Will update the light (duh). Creates or destroys it if needed, makes it update values, makes sure it's got the correct source turf...

update_name

Updates the name of the atom

update_overlays

Updates the overlays of the atom

update_remote_sight

the sight changes to give to the mob whose perspective is set to that atom

(e.g. A mob with nightvision loses its nightvision while looking through a normal camera)

visible_message

Generate a visible message from this atom

@@ -2340,7 +2340,7 @@

Var Details

call back when a var is edited on this atom

@@ -2351,14 +2351,14 @@

Var Details

Return the markup to for the dropdown list for the VV panel for this atom

Override in subtypes to add custom VV handling in the VV panel

wash

Wash this atom

@@ -2370,62 +2370,62 @@

Var Details

Called on an object when a tool with welder capabilities is used to left click an object

welder_act_secondary + +

Called on an object when a tool with welder capabilities is used to right click an object

wirecutter_act + +

Called on an object when a tool with wirecutter capabilities is used to left click an object

wirecutter_act_secondary + +

Called on an object when a tool with wirecutter capabilities is used to right click an object

wrench_act + +

Called on an object when a tool with wrench capabilities is used to left click an object

wrench_act_secondary + +

Called on an object when a tool with wrench capabilities is used to right click an object

zap_act

Respond to an electric bolt action on our item

Default behaviour is to return, we define here to allow for cleaner code later on

zas_canpass

Checks whether or not ZAS can occupy this atom's turf. Invoked by the ATMOS_CANPASS_TURF macro.

zas_update_loc

Tells ZAS to mark the tile the atom is in to update.

diff --git a/atom/movable.html b/atom/movable.html index 4ed5b0451a50..a5f83410cbfc 100644 --- a/atom/movable.html +++ b/atom/movable.html @@ -16,7 +16,7 @@

movable - +

@@ -171,152 +171,152 @@

Var Details

Lazylist to keep track on the sources of illumination.

affecting_dynamic_lumi - +

Highest-intensity light affecting us, which determines our visibility.

airflow_dest - +

The location the atom is trying to step towards during airflow.

airflow_old_density - +

If the movable is dense by default, it won't step into tiles containing other dense objects

airflow_speed - +

The speed the object is travelling during airflow

airflow_time - +

Time (ticks) spent in airflow

blocks_emissive - +

Either FALSE, EMISSIVE_BLOCK_GENERIC, or EMISSIVE_BLOCK_UNIQUE

bound_overlay - +

The mimic (if any) that's directly copying us.

buckle_lying - +

Bed-like behaviour, forces mob.lying = buckle_lying if not set to NO_BUCKLE_LYING.

buckle_prevents_pull - +

Whether things buckled to this atom can be pulled while they're buckled

buckle_requires_restraints - +

Require people to be handcuffed before being able to buckle. eg: pipes

buckled_mobs - +

The mobs currently buckled to this atom

can_be_unanchored - +

Used for the calculate_adjacencies proc for icon smoothing.

can_buckle - +

Whether the atom allows mobs to be buckled to it. Can be ignored in [/atom/movable/proc/buckle_mob()] if force = TRUE

client_mobs_in_contents - +

contains every client mob corresponding to every client eye in this container. lazily updated by SSparallax and is sparse: only the last container of a client eye has this list assuming no movement since SSparallax's last fire

contents_pressure_protection - +

The degree of pressure protection that mobs in list/contents have from the external environment, between 0 and 1

contents_thermal_insulation - +

The degree of thermal insulation that mobs in list/contents have from the external environment, between 0 and 1

currently_z_moving - +

is the mob currently ascending or descending through z levels?

do_afters - +

For storing what do_after's someone has, key = string, value = amount of interactions of that type happening.

em_block - +

Internal holder for emissive blocker object, do not use directly use blocks_emissive

forcemove_should_maintain_grab - +

Tracks if forceMove() should break grabs or not.

generic_canpass - +

If false makes CanPass call CanPassThrough on this type instead of using default behaviour

germ_level - +

Look, we're defining this here so it doesn't need to be redefined 4 times, okay? Sorry.

grabbed_by - +

A lazylist of grab objects gripping us

important_recursive_contents - +

an associative lazylist of relevant nested contents by "channel", the list is of the form: list(channel = list(important nested contents of that type)) each channel has a specific purpose and is meant to replace potentially expensive nested contents iteration. @@ -324,50 +324,50 @@

Var Details

Delay in deciseconds between inertia based movement

inertia_moving - +

Are we moving with inertia? Mostly used as an optimization

last_airflow - +

Time (ticks) since last airflow movement

last_move - +

The last direction we moved in.

last_pushoff - +

The last time we pushed off something This is a hack to get around dumb him him me scenarios

max_buckled_mobs - +

The maximum number of mob/livings allowed to be buckled to this atom at once

move_packet - +

Holds information about any movement loops currently running/waiting to run on the movable. Lazy, will be null if nothing's going on

movement_type - +

In case you have multiple types, you automatically use the most useful one. IE: Skating on ice, flippers on water, flying over chasm/space, etc. @@ -375,37 +375,37 @@

Var Details

Bump() magic

moving_diagonally - +

0: not doing a diagonal move. 1 and 2: doing the first/second step of the diagonal move

moving_from_pull - +

Tracks if the mob is currently in the movechain during a pulling movement.

pass_flags - +

Things we can pass through while moving. If any of this matches the thing we're trying to pass's [pass_flags_self], then we can pass through.

set_dir_on_move - +

Whether this atom should have its dir automatically changed when it moves. Setting this to FALSE allows for things such as directional windows to retain dir on moving without snowflake code all of the place.

spatial_grid_key - +

String representing the spatial grid groups we want to be held in. acts as a key to the list of spatial grid contents types we exist in via SSspatial_grid.spatial_grid_categories. @@ -413,49 +413,49 @@

Var Details

How much damage the object deals when impacting something else.

throwing - +

A ref to the throwing datum belonging to us.

tk_throw_range - +

Max range this atom can be thrown via telekinesis

zmm_flags - +

Movable-level Z-Mimic flags. This uses ZMM_* flags, not ZM_* flags.

Proc Details

CanPassThrough

Returns true or false to allow src to move through the blocker, mover has final say

CanReach

A backwards depth-limited breadth-first-search to see if the target is logically "in" anything adjacent to us.

Crossed

default byond proc that is deprecated for us in lieu of signals. do not call

Moved

Called after a successful Move(). By this point, we've already moved. @@ -469,7 +469,7 @@

Var Details

Called whenever an object moves and by mobs when they attempt to move themselves through space @@ -483,7 +483,7 @@

Var Details

Uncross() is a default BYOND proc that is called when something is going @@ -503,7 +503,7 @@

Var Details

default byond proc that is normally called on everything inside the previous turf @@ -512,7 +512,7 @@

Var Details

meant for movement with zero side effects. only use for objects that are supposed to move "invisibly" (like camera mobs or ghosts) @@ -520,56 +520,56 @@

Var Details

Adds a language to the blocked language list. Use this over remove_language in cases where you will give languages back later.

admin_teleport

Proc to hook user-enacted teleporting behavior and keep logging of the event.

airflow_hit

Called when src collides with A during airflow

become_active_storage

called when this movable becomes the parent of a storage component that is currently being viewed by a player. uses important_recursive_contents

become_area_sensitive

We get our awareness updated by the important recursive contents stuff, here we remove our membership allows this movable to know when it has "entered" another area no matter how many movable atoms its stuffed into, uses important_recursive_contents

become_hearing_sensitive

allows this movable to hear and adds itself to the important_recursive_contents list of itself and every movable loc its in

become_radio_sensitive

allows this movable to hear and adds itself to the important_recursive_contents list of itself and every movable loc its in

block_superconductivity

Currently unused.

buckle_mob

Set a mob as buckled to src

@@ -582,19 +582,19 @@

Var Details

Checks if atom can speak the language.

can_step_into

Tests if src can move from their current loc to an adjacent destination, without doing the move.

can_z_move

Checks if the destination turf is elegible for z movement from the start turf to a given direction and returns it if so. @@ -607,19 +607,19 @@

Var Details

Checks to see if airflow can move this movable.

check_zclimb

Returns an object we can climb onto

compose_message

Vars

Procs

copy_hudsCopies the atom_huds of the given atom.

Proc Details

copy_huds

Copies the atom_huds of the given atom.

diff --git a/atom/movable/plane_master_controller.html b/atom/movable/plane_master_controller.html index 0c8870736c88..580530f3c583 100644 --- a/atom/movable/plane_master_controller.html +++ b/atom/movable/plane_master_controller.html @@ -16,7 +16,7 @@

plane_master_controller - +

Atom that manages and controls multiple planes. It's an atom so we can hook into add_filter etc. Multiple controllers can control one plane.

@@ -34,66 +34,66 @@

Var Details

List of planes in this controllers control. Initially this is a normal list, but becomes an assoc list of plane numbers as strings | plane instance

owner_hud - +

hud that owns this controller

Proc Details

Initialize

Ensures that all the planes are correctly in the controlled_planes list.

add_atom_colour

Full override so we can just use filterrific

add_filter

Full override so we can just use filterrific

get_filters

Gets all filters for this controllers plane masters

remove_atom_colour

Removes an instance of colour_type from the atom's atom_colours list

remove_filter

Full override so we can just use filterrific

transition_filter

Transitions all filters owned by this plane master controller

update_atom_colour

Resets the atom's color to null, and then sets it to the highest priority colour available

diff --git a/atom/movable/screen.html b/atom/movable/screen.html index ac9c7a8cb36c..2830307e71d8 100644 --- a/atom/movable/screen.html +++ b/atom/movable/screen.html @@ -16,7 +16,7 @@

screen - +

Vars

@@ -34,14 +34,14 @@

Var Details

Map name assigned to this object. Automatically set by /client/proc/add_obj_to_map.

del_on_map_removal - +

Mark this object as garbage-collectible after you clean the map it was registered on.

@@ -50,31 +50,31 @@

Var Details

- +

A reference to the owner HUD, if any.

master_ref - +

A reference to the object in the slot. Grabs or items, generally, but any datum will do.

private_screen - +

If set to TRUE, mobs that do not own this hud cannot click this screen object.

Proc Details

fill_rect

Sets screen_loc to fill a rectangular area of the map.

If applicable, "assigned_map" has to be assigned before this proc call.

set_position

Sets screen_loc of this screen object, in form of point coordinates, @@ -82,7 +82,7 @@

Var Details

Vars

Procs

hit_byReacts to having a button dropped on it

Proc Details

hit_by

Reacts to having a button dropped on it

diff --git a/atom/movable/screen/admin_popup.html b/atom/movable/screen/admin_popup.html index 45ab7f35a176..5f2bba59198d 100644 --- a/atom/movable/screen/admin_popup.html +++ b/atom/movable/screen/admin_popup.html @@ -16,7 +16,7 @@

admin_popup - +

The UI element for admin popups

@@ -26,18 +26,18 @@

Var Details

The last color chosen in the animation, sourced from the static list colors.

last_update_time - +

The world.time when the last color update occurred.

diff --git a/atom/movable/screen/alert.html b/atom/movable/screen/alert.html index fcf60620d32f..fa95bf54f749 100644 --- a/atom/movable/screen/alert.html +++ b/atom/movable/screen/alert.html @@ -16,7 +16,7 @@

alert - +

Vars

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

Var Details

Boolean. If TRUE, the Click() proc will attempt to Click() on the master first if there is a master.

diff --git a/atom/movable/screen/alert/give.html b/atom/movable/screen/alert/give.html index 15d60a8a6366..7e7f9a5ec12a 100644 --- a/atom/movable/screen/alert/give.html +++ b/atom/movable/screen/alert/give.html @@ -16,7 +16,7 @@

give - +

Vars

@@ -24,13 +24,13 @@

give

Procs

setupHandles assigning most of the variables for the alert that pops up when an item is offered

Proc Details

handle_transfer

An overrideable proc used simply to hand over the item when claimed, this is a proc so that high-fives can override them since nothing is actually transferred

setup

Handles assigning most of the variables for the alert that pops up when an item is offered

@@ -44,7 +44,7 @@

give