carrier_room

carrier Room

This datum is where souls are sent to when joining soulcatchers. It handles sending messages to souls from the outside along with adding new souls, transfering, and removing souls.

Vars
current_mobs	What souls are currently inside of the room?
current_overlay_path	What overlay is being currently used? Don't directly change this, use `change_fullscreen_overlay()`
joinable	Can the room be joined at all?
master_carrier	Weakref for the master carrier datum
name	What is the name of the room?
outside_voice	What is the name of the person sending the messages?
overlay_color	What color do we want the overlay to be, if any?
overlay_recolorable	Is our overlay recolorable? This is here for TGUI
room_color	What is the color of chat messages sent by the room?
room_description	What is the description of the room?
Procs
add_mob	Adds a mob into the carrier
add_soul_from_mind	Converts a mind into a soul and adds the resulting soul to the room.
change_fullscreen_overlay	Changes the fullscreen overlay for everyone inside of the current carrier room
relay_message_to_carrier	Relays a message sent from the send_message proc to the parent carrier datum
remove_mob	Removes a mob from a carrier room, leaving it as a ghost. Returns `FALSE` if the `mob_to_remove` cannot be found, otherwise returns `TRUE` after a successful deletion.
send_message	Sends a message or emote to all of the souls currently located inside of the carrier room. Returns `FALSE` if a message cannot be sent, otherwise returns `TRUE`.
set_overlay_for_mob	Sets the current overlay for a mob

Var Details

var
current_mobs
– /list

What souls are currently inside of the room?

var
current_overlay_path
– /atom/movable/screen/fullscreen/carrier

What overlay is being currently used? Don't directly change this, use change_fullscreen_overlay()

var
joinable
–

Can the room be joined at all?

var
master_carrier
– /datum/weakref

Weakref for the master carrier datum

var
name
–

What is the name of the room?

var
outside_voice
–

What is the name of the person sending the messages?

var
overlay_color
–

What color do we want the overlay to be, if any?

var
overlay_recolorable
–

Is our overlay recolorable? This is here for TGUI

var
room_color
–

What is the color of chat messages sent by the room?

var
room_description
–

What is the description of the room?

Proc Details

proc
add_mob
(/mob/living/mob_to_add)

Adds a mob into the carrier

proc
add_soul_from_mind
(/datum/mind/mind_to_add, hide_participant_identity)

Converts a mind into a soul and adds the resulting soul to the room.

proc
change_fullscreen_overlay
(/atom/movable/screen/fullscreen/carrier/new_fullscreen)

Changes the fullscreen overlay for everyone inside of the current carrier room

proc
relay_message_to_carrier
(message)

Relays a message sent from the send_message proc to the parent carrier datum

proc
remove_mob
(/mob/living/mob_to_remove)

Removes a mob from a carrier room, leaving it as a ghost. Returns FALSE if the mob_to_remove cannot be found, otherwise returns TRUE after a successful deletion.

proc
send_message
(message_to_send, sender_name, /mob/living/sender_mob, emote)

Sends a message or emote to all of the souls currently located inside of the carrier room. Returns FALSE if a message cannot be sent, otherwise returns TRUE.

Arguments

message_to_send - The message we want to send to the occupants of the room
sender_name - The person that is sending the message. This is not required.
sender_mob - The person that is sending the message. This is not required.
emote - Is the message sent an emote or not?

proc
set_overlay_for_mob
(/mob/living/occupant)

Sets the current overlay for a mob

carrier_room /datum/carrier_room

Vars

Procs

Var Details

var current_mobs – /list

var current_overlay_path – /atom/movable/screen/fullscreen/carrier

var joinable –

var master_carrier – /datum/weakref

var name –

var outside_voice –

var overlay_color –

var overlay_recolorable –

var room_color –

var room_description –