diff --git a/area.html b/area.html index 2cc8c420c9764..f87929e16a7fc 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

@@ -71,170 +71,170 @@

Var Details

This gets overridden to 1 for space in area/Initialize(mapload).

areasize - +

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

atmosalm - +

Whether there is an atmos alarm in this area

beauty - +

Beauty average per open turf in the area

beauty_threshold - +

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

clockwork_warp_allowed - +

whether servants can warp into this area from Reebe

clockwork_warp_fail - +

Message to display when the clockwork warp fails

considered_hull_exterior - +

Considered space for hull shielding

dirt_buildup_allowed - +

Dirty flooring allowed

fire - +

Do we have an active fire alarm?

flora_allowed - +

If flora are allowed to spawn in this area randomly through tunnel generation

hidden - +

Hides area from player Teleport function.

map_generator - +

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

map_name - +

CIT SPECIFIC VARS Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints.

megafauna_spawn_allowed - +

If megafauna can be spawned by natural random generation

minimap_color - +

Color on minimaps, if it's null (which is default) it makes one at random.

mob_spawn_allowed - +

if mobs can be spawned by natural random generation

mood_bonus - +

Bonus mood for being in this area

mood_message - +

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

outdoors - +

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

parallax_move_angle - +

Parallax move dir - degrees clockwise from north

parallax_move_speed - +

Parallax move speed - 0 to disable

parallax_moving - +

Parallax moving?

persistent_debris_allowed - +

Persistent debris alowed

requires_power - +

Will objects this area be needing power?

safe - +

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

sound_environment - +

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

sub_areas - +

These two vars allow for multiple unique areas to be linked to a master area and share some functionalities such as APC powernet nodes, fire alarms etc, without sacrificing @@ -243,30 +243,30 @@

Var Details

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

triggered_firealarms - +

How many fire alarm sources do we have?

tunnel_allowed - +

If mining tunnel generation is allowed in this area

valid_malf_hack - +

malf ais can hack this

Proc Details

Destroy

Destroy an area and clean it up

@@ -275,7 +275,7 @@

Var Details

Call back when an atom enters an area

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

@@ -299,46 +299,46 @@

Var Details

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

clear_camera

Get rid of any dangling camera refs

poweralert

Generate a power alert for this area

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

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

update_beauty

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

update_icon_state

Update the icon state of the area

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

Var Details

Vars

Procs

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

Proc Details

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 33372a2ed4683..a5b0da1412adc 100644 --- a/atom.html +++ b/atom.html @@ -16,7 +16,7 @@

atom - +

The base type for nearly all physical objects in SS13

@@ -121,248 +121,248 @@

Var Details

a very temporary list of overlays to add

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

attack_hand_is_action - +

Should we set last action for attack hand? This implies that attack_hands to this atom should flush to clickdelay buffers instead of discarding.

attack_hand_speed - +

Amount of time to check for from a mob's last attack to allow an attack_hand().

attack_hand_unwieldlyness - +

Amount of time to hard stagger (no clicking at all) the mob post attack_hand(). Lower = better

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.

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.

custom_premium_price - +

Price of an item in a vending machine, overriding the premium vending machine price. Define in terms of paycheck defines as opposed to raw numbers.

custom_price - +

Price of an item in a vending machine, overriding the base vending machine price. Define in terms of paycheck defines as opposed to raw numbers.

explosion_block - +

Value used to increment ex_act() if reactionary_explosions is on

explosion_flags - +

Flags for explosions

fingerprintslast - +

Last fingerprints to touch this atom

flags_1 - +

First atom flags var

hud_list - +

This atom's HUD (med/sec, etc) images. Associative list.

hud_possible - +

HUD images that this atom can provide.

interaction_flags_atom - +

Intearaction flags

managed_overlays - +

overlays managed by update_overlays to prevent removing overlays that weren't added by the same proc

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.

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.

proximity_monitor - +

Proximity monitor associated with this atom

rad_insulation - +

Radiation insulation types

reagents - +

Reagents holder

remove_overlays - +

a very temporary list of overlays to remove

ricochet_chance_mod - +

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

ricochet_damage_mod - +

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

targeted_by - +

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

wave_explosion_block - +

Amount to decrease wave explosions by

wave_explosion_multiply - +

Amount to multiply wave explosions by

Proc Details

AltClickNoInteract

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

CanAllowThrough

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

ComponentInitialize

Put your AddComponent calls here

Destroy

Top level of the destroy chain for most atoms

@@ -376,7 +376,7 @@

Var Details

The primary method that objects are setup in SS13 with

@@ -406,7 +406,7 @@

Var Details

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

Var Details

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

@@ -430,13 +430,13 @@

Var Details

Wrapper to return a copy of contents, as SDQL2 can't tell an internal list from a normal list.

add_context

Creates a "Type-B" contextual screentip interaction. @@ -449,7 +449,7 @@

Var Details

Show a message to all mobs in earshot of this atom

@@ -465,20 +465,20 @@

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.

bullet_act

React to a hit by a projectile object

@@ -489,14 +489,14 @@

Var Details

Checks if a projectile should ricochet off of us. Projectiles get final say. [__DEFINES/projectiles.dm] for return values.

connect_to_shuttle

Called after a shuttle is loaded from map template initially.

@@ -508,7 +508,7 @@

Var Details

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

@@ -517,13 +517,13 @@

Var Details