dmdoc: Some cleanups. (#27242)

* dmdoc: Some cleanups.

* satisfy check_grep
This commit is contained in:
warriorstar-orion
2024-11-13 13:37:37 +00:00
committed by GitHub
parent f6a45ae95e
commit bfb18b48e4
24 changed files with 80 additions and 67 deletions
+1 -1
View File
@@ -102,7 +102,7 @@ RESTRICT_TYPE(/datum/team/cult)
/**
* Returns the current number of cultists and constructs.
*
* Returns the number of cultists and constructs in a list ([1] = Cultists, [2] = Constructs), or as one combined number.
* Returns the number of cultists and constructs in the format `list(number of Cultists, number of Constructs)`, or as one combined number.
*
* * separate - Should the number be returned as a list with two separate values (Humans and Constructs) or as one number.
*/
@@ -157,7 +157,7 @@
var/list/datum/mind/target_blacklist = null
/// Static list that is basically [/datum/objective/contract/var/possible_zone_names] but with area names replaced by /area objects if available.
var/static/list/possible_zones = null
/// The owning [/datum/syndicatce_contract].
/// The owning [/datum/syndicate_contract].
var/datum/syndicate_contract/owning_contract = null
/// Name fixer regex because area names have rogue characters sometimes.
var/static/regex/name_fixer = regex("(\[a-z0-9 \\'\]+)$", "ig")
+2 -2
View File
@@ -311,9 +311,9 @@ GLOBAL_LIST_EMPTY(asset_datums)
var/frame = 1
var/movement_states = FALSE
/// Used in asset name generation, (asset_name = "[prefix].[icon_state_name].png")
/// Used in asset name generation, (asset_name = `"[prefix].[icon_state_name].png"`)
var/prefix = "default"
/// Generate icon filenames using GENERATE_ASSET_NAME instead the "[prefix].[icon_state_name].png" format
/// Generate icon filenames using GENERATE_ASSET_NAME instead the `"[prefix].[icon_state_name].png"` format
var/generic_icon_names = FALSE
/datum/asset/simple/icon_states/register(_icon = icon)
@@ -14,7 +14,8 @@
* This makes it easier to track stuff down -AA07
*
* Also if you have used other languages before with "interface" types (Java, C# (Microsoft Java), etc),
* treat this class as one of those. [get_query(client/C)] and [process_result(datum/db_query/Q, client/C)] MUST be overriden
* treat this class as one of those. [/datum/client_login_processor/proc/get_query] and
* [/datum/client_login_processor/proc/process_result] MUST be overriden.
*/
/datum/client_login_processor
/// The login priority. A lower priority will fire first
+21 -13
View File
@@ -1,18 +1,26 @@
/**
Shows a ticker reading out the given text on a client's screen.
targets = mob or list of mobs to show it to.
duration = how long it lingers after it finishes ticking.
message = the message to display. Due to using maptext it isn't very flexible format-wise. 11px font, up to 480 pixels per line. Use \n for line breaks. Single-character HTML tags (<b>, <i>, <u> etc.) are handled correctly but others display strangely. Note that maptext can display text macros in strange ways, ex. \improper showing as "ÿ". Lines containing only spaces, including ones only containing "\improper ", don't display.
scroll_down = by default each line pushes the previous line upwards - this tells it to start high and scroll down. Ticks on \n - does not autodetect line breaks in long strings.
screen_position = screen loc for the bottom-left corner of the blurb.
text_alignment = "right", "left", or "center"
text_color = colour of the text.
blurb_key = a key used for specific blurb types so they are not shown repeatedly.
ignore_key = used to skip key checks.
text_limit = limit in characters of the message.
* Shows a ticker reading out the given text on a client's screen.
*
* Arguments:
* * targets - mob or list of mobs to show it to.
* * duration - how long it lingers after it finishes ticking.
* * message - the message to display. Due to using maptext it isn't very
* flexible format-wise. 11px font, up to 480 pixels per line. Use `\n` for
* line breaks. Single-character HTML tags (`<b>`, `<i>`, `<u>` etc.) are handled
* correctly but others display strangely. Note that maptext can display text
* macros in strange ways, ex. \improper showing as "&yuml;". Lines containing
* only spaces, including ones only containing "\improper ", don't display.
* * scroll_down - by default each line pushes the previous line upwards - this
* tells it to start high and scroll down. Ticks on `\n` - does not autodetect
* line breaks in long strings.
* * screen_position - screen loc for the bottom-left corner of the blurb.
* * text_alignment - "right", "left", or "center"
* * text_color - colour of the text.
* * blurb_key - a key used for specific blurb types so they are not shown
* repeatedly.
* * ignore_key - used to skip key checks.
* * text_limit - limit in characters of the message.
**/
/proc/show_blurb(list/mob/targets, duration = 3 SECONDS, message, scroll_down, screen_position = "LEFT+0:16,BOTTOM+1:16", text_alignment = "left", text_color = "#FFFFFF", blurb_key, ignore_key = FALSE, speed = 1)
set waitfor = 0
if(!islist(targets))
+1 -1
View File
@@ -1,4 +1,4 @@
/// Called on [/mob/living/Initialize(mapload)], for the mob to register to relevant signals.
/// Called on [/mob/living/proc/Initialize], for the mob to register to relevant signals.
/mob/living/proc/register_init_signals()
RegisterSignal(src, SIGNAL_ADDTRAIT(TRAIT_KNOCKEDOUT), PROC_REF(on_knockedout_trait_gain))
RegisterSignal(src, SIGNAL_REMOVETRAIT(TRAIT_KNOCKEDOUT), PROC_REF(on_knockedout_trait_loss))
+2 -2
View File
@@ -17,7 +17,7 @@
*
* Incomplete light tube fixture
*
* Becomes a [Light fixture] when completed
* Becomes a [/obj/machinery/light/built] when completed.
*/
/obj/machinery/light_construct
name = "light fixture frame"
@@ -133,7 +133,7 @@
*
* Incomplete light bulb fixture
*
* Becomes a [Small light fixture] when completed
* Becomes a [/obj/machinery/light/small/built] when completed
*/
/obj/machinery/light_construct/small
name = "small light fixture frame"
+9 -6
View File
@@ -43,12 +43,15 @@
* to_chat(client, "You have found <strong>[object]</strong>", MESSAGE_TYPE_INFO,
* ```
* Always remember to close spans!
* TARGET: Refers to the target of the to_chat message. Valid targets include clients, mobs, and the static world controller
* HTML: The Message to be sent to the TARGET. Converted to a string if not already one in this function
* TYPE: The chat tab that this message will be sent to, a list of all valid types can be found in chat.dm
* TEXT: Unused
* AVOID_HIGHLIGHTING: Unused
* trailing_newline, confidential, and handle_whitespace currently have no effect, please fix this in the future or remove the arguments to lower cache!
*
* Arguments:
* - target: Refers to the target of the to_chat message. Valid targets include clients, mobs, and the static world controller
* - html: The Message to be sent to the TARGET. Converted to a string if not already one in this function
* - type: The chat tab that this message will be sent to, a list of all valid types can be found in chat.dm
* - text: Unused
* - avoid_highlighting: Unused
*
* `trailing_newline`, `confidential`, and `handle_whitespace` currently have no effect, please fix this in the future or remove the arguments to lower cache!
*/
/proc/to_chat(target, html, type, text, avoid_highlighting, handle_whitespace = TRUE, trailing_newline = TRUE, confidential = FALSE, ticket_id = -1)
if(Master.current_runlevel == RUNLEVEL_INIT || !SSchat?.initialized)
+2 -2
View File
@@ -11,7 +11,7 @@
* This includes sanity checking for if the key is required, as well as other sanity checks
* DO NOT OVERRIDE
* Arguments:
* * input - The list of topic data, sent from [world/Topic]
* * input - The list of topic data, sent from [/world/proc/Topic]
*/
/datum/world_topic_handler/proc/invoke(list/input)
SHOULD_NOT_OVERRIDE(TRUE)
@@ -28,7 +28,7 @@
* Override this to do your work in subtypes of this topic
*
* Arguments:
* * input - The list of topic data, sent from [world/Topic]
* * input - The list of topic data, sent from [/world/proc/Topic]
* * key_valid - Has the user entered the correct auth key
*/
/datum/world_topic_handler/proc/execute(list/input, key_valid = FALSE)