Chat Message Overlay
Datum for generating a message overlay on the map
Vars | |
animate_lifespan | Our animation lifespan, how long this message will last |
---|---|
animate_start | When we started animating the message |
approx_lines | Contains the approximate amount of lines for height decay |
current_z_idx | The current index used for adjusting the layer of each sequential chat message such that recent messages will overlay older ones |
eol_complete | Contains the time that the EOL for the message will be complete, used for qdel scheduling |
finish_callback | Callback to finish_image_generation passed to SSrunechat |
message | The visual element of the chat message |
message_loc | The location in which the message is appearing |
owned_by | The client who heard this message |
scheduled_destruction | Contains the scheduled destruction time, used for scheduling EOL |
Procs | |
New | Constructs a chat message overlay |
finish_image_generation | finishes the image generation after the MeasureText() call in generate_image(). necessary because after that call the proc can resume at the end of the tick and cause overtime. |
generate_image | Generates a chat message image representation |
on_parent_qdel | Calls qdel on the chatmessage when its parent is deleted, used to register qdel signal |
Var Details
animate_lifespan
Our animation lifespan, how long this message will last
animate_start
When we started animating the message
approx_lines
Contains the approximate amount of lines for height decay
current_z_idx
The current index used for adjusting the layer of each sequential chat message such that recent messages will overlay older ones
eol_complete
Contains the time that the EOL for the message will be complete, used for qdel scheduling
finish_callback
Callback to finish_image_generation passed to SSrunechat
message
The visual element of the chat message
message_loc
The location in which the message is appearing
owned_by
The client who heard this message
scheduled_destruction
Contains the scheduled destruction time, used for scheduling EOL
Proc Details
New
Constructs a chat message overlay
Arguments:
- text - The text content of the overlay
- target - The target atom to display the overlay at
- owner - The mob that owns this overlay, only this mob will be able to view it
- language - The language this message was spoken in
- extra_classes - Extra classes to apply to the span that holds the text
- lifespan - The lifespan of the message in deciseconds
finish_image_generation
finishes the image generation after the MeasureText() call in generate_image(). necessary because after that call the proc can resume at the end of the tick and cause overtime.
generate_image
Generates a chat message image representation
Arguments:
- text - The text content of the overlay
- target - The target atom to display the overlay at
- owner - The mob that owns this overlay, only this mob will be able to view it
- language - The language this message was spoken in
- extra_classes - Extra classes to apply to the span that holds the text
- lifespan - The lifespan of the message in deciseconds
on_parent_qdel
Calls qdel on the chatmessage when its parent is deleted, used to register qdel signal