cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-07-21 03:55:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Makes /obj documentation better. (#30433)

Browse Source 
* Update objs.dm

* Update objs.dm

* Apply suggestions from code review

Co-authored-by: warriorstar-orion <orion@snowfrost.garden>
Signed-off-by: CRUNCH <143041327+Fordoxia@users.noreply.github.com>

---------

Signed-off-by: CRUNCH <143041327+Fordoxia@users.noreply.github.com>
Co-authored-by: warriorstar-orion <orion@snowfrost.garden>
This commit is contained in:
CRUNCH
2025-09-27 21:34:24 +01:00
committed by GitHub
parent 8b0c249d97
commit bb61976b97
1 changed files with 38 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
code/game/objects/objs.dm
+38 -25
View File
@@ -1,36 +1,48 @@
/obj
//var/datum/module/mod //not used
var/origin_tech = null //Used by R&D to determine what research bonuses it grants.
animate_movement = SLIDE_STEPS
var/list/species_exception = null // list() of species types, if a species cannot put items in a certain slot, but species type is in list, it will be able to wear that item
var/sharp = FALSE // whether this object cuts
var/in_use = FALSE // If we have a user using us, this will be set on. We will check if the user has stopped using us, and thus stop updating and LAGGING EVERYTHING!
/// Used by R&D to determine what research bonuses it grants.
var/origin_tech = null
/// A list of otherwise restricted /datum/species type paths that are permitted to wear this item.
var/list/species_exception = null
/// Can this object cut?
var/sharp = FALSE
/// If we have a user using us, this will become `TRUE`. We will check if the user has stopped using us, and thus stop updating and LAGGING EVERYTHING!
var/in_use = FALSE
/// What type of damage does this object deal?
var/damtype = "brute"
/// How much damage this object does in melee.
var/force = 0
// You can define armor as a list in datum definition (e.g. `armor = list("fire" = 80, "brute" = 10)`),
// which would be converted to armor datum during initialization.
// Setting `armor` to a list on an *existing* object would inevitably runtime. Use `getArmor()` instead.
var/datum/armor/armor
var/obj_integrity //defaults to max_integrity
/// Health of the object. If unspecified, defaults to `max_integrity`.
var/obj_integrity
/// Maximum health of the object, and default value of `obj_integrity`.
var/max_integrity = 500
var/integrity_failure = 0 //0 if we have no special broken behavior
///Damage under this value will be completely ignored
/// Health threshold below which the object will break. Defaults to 0 for no special broken behavior.
var/integrity_failure = 0
/// Damage under this value will be completely ignored.
var/damage_deflection = 0
var/resistance_flags = NONE // INDESTRUCTIBLE
var/custom_fire_overlay // Update_fire_overlay will check if a different icon state should be used
var/acid_level = 0 //how much acid is on that obj
var/can_be_hit = TRUE //can this be bludgeoned by items?
/// Flags that make this object harder to destroy, e.g. [ACID_PROOF], [FIRE_PROOF], [INDESTRUCTIBLE].
var/resistance_flags = NONE
/// If provided, a custom overlay representing being the object being on fire.
var/custom_fire_overlay
/// How much acid is on this object?
var/acid_level = 0
/// Can this object be attacked in melee?
var/can_be_hit = TRUE
/// Is this object currently being zapped by lightning?
var/being_shocked = FALSE
/// Should this object speed process? Greatly increases the frequency of process events (5 times more frequent).
var/speed_process = FALSE
var/on_blueprints = FALSE //Are we visible on the station blueprints at roundstart?
var/force_blueprints = FALSE //forces the obj to be on the blueprints, regardless of when it was created.
var/suicidal_hands = FALSE // Does it requires you to hold it to commit suicide with it?
/// Is it emagged or not?
/// Are we visible on the station blueprints at roundstart?
var/on_blueprints = FALSE
/// Forces the object to be on the blueprints, regardless of when it was created.
var/force_blueprints = FALSE
/// Does this object require you to hold it to commit suicide with it?
var/suicidal_hands = FALSE
/// Is this object emagged?
var/emagged = FALSE
// Access-related fields
@@ -83,7 +95,7 @@
STOP_PROCESSING(SSfastprocess, src)
return ..()
//Output a creative message and then return the damagetype done
/// Override this to enable special self-termination interactions on an object when using the suicide command.
/obj/proc/suicide_act(mob/user)
return FALSE
@@ -174,7 +186,8 @@
/obj/proc/hear_message(mob/M, text)
return
/obj/proc/default_welder_repair(mob/user, obj/item/I) //Returns TRUE if the object was successfully repaired. Fully repairs an object (setting BROKEN to FALSE), default repair time = 40
/// Returns `TRUE` if the object was successfully repaired. Fully repairs an object (setting `BROKEN` to `FALSE`), default repair time = 40.
/obj/proc/default_welder_repair(mob/user, obj/item/I)
if(obj_integrity >= max_integrity)
to_chat(user, "<span class='notice'>[src] does not need repairs.</span>")
return
@@ -190,6 +203,7 @@
update_icon()
return TRUE
/// Handles (un)anchoring. Returns `TRUE` if successful, otherwise returns `FALSE`.
/obj/proc/default_unfasten_wrench(mob/user, obj/item/I, time = 20)
if(!anchored && !isfloorturf(loc))
user.visible_message("<span class='warning'>A floor must be present to secure [src]!</span>")
@@ -256,9 +270,8 @@
if(!sharp && new_sharp_val)
AddComponent(/datum/component/surgery_initiator)
/// This proc handles safely removing occupant mobs from the object if they must be teleported out (due to being SSD/AFK, by admin teleport, etc) or transformed.
/obj/proc/force_eject_occupant(mob/target)
// This proc handles safely removing occupant mobs from the object if they must be teleported out (due to being SSD/AFK, by admin teleport, etc) or transformed.
// In the event that the object doesn't have an overriden version of this proc to do it, log a runtime so one can be added.
CRASH("Proc force_eject_occupant() is not overridden on a machine containing a mob.")