soulcatcher_room

Soulcatcher 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_souls	What souls are currently inside of the room?
joinable	Can the room be joined at all?
master_soulcatcher	Weakref for the master soulcatcher datum
name	What is the name of the room?
outside_voice	What is the name of the person sending the messages?
room_color	What is the color of chat messages sent by the room?
room_description	What is the description of the room?
Procs
add_soul	Converts a mind into a soul and adds the resulting soul to the room.
add_soul_from_ghost	Attemps to add a ghost to the soulcatcher room.
relay_message_to_soulcatcher	Relays a message sent from the send_message proc to the parent soulcatcher datum
remove_soul	Removes a soul from a soulcatcher room, leaving it as a ghost. Returns `FALSE` if the `soul_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 soulcatcher room. Returns `FALSE` if a message cannot be sent, otherwise returns `TRUE`.
transfer_soul	Transfers a soul from a soulcatcher room to another soulcatcher room. Returns `FALSE` if the target room or target soul cannot be found.

Var Details

var
current_souls
– /list

What souls are currently inside of the room?

var
joinable
–

Can the room be joined at all?

var
master_soulcatcher
– /datum/weakref

Weakref for the master soulcatcher datum

var
name
–

What is the name of the room?

var
outside_voice
–

What is the name of the person sending the messages?

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_soul
(/datum/mind/mind_to_add)

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

proc
add_soul_from_ghost
(/mob/dead/observer/ghost)

Attemps to add a ghost to the soulcatcher room.

proc
relay_message_to_soulcatcher
(message)

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

proc
remove_soul
(/mob/living/soulcatcher_soul/soul_to_remove)

Removes a soul from a soulcatcher room, leaving it as a ghost. Returns FALSE if the soul_to_remove cannot be found, otherwise returns TRUE after a successful deletion.

proc
send_message
(message_to_send, message_sender, emote)

Sends a message or emote to all of the souls currently located inside of the soulcatcher 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
message_sender - The person that is sending the message. This is not required.
emote - Is the message sent an emote or not?

proc
transfer_soul
(/mob/living/soulcatcher_soul/target_soul, /datum/soulcatcher_room/target_room)

Transfers a soul from a soulcatcher room to another soulcatcher room. Returns FALSE if the target room or target soul cannot be found.

soulcatcher_room /datum/soulcatcher_room

Vars

Procs

Var Details

var current_souls – /list

var joinable –

var master_soulcatcher – /datum/weakref

var name –

var outside_voice –

var room_color –

var room_description –