label
The label item applied when labelling something
Vars | |
| label_name | The text on the label |
|---|---|
| sticking_to | What atom we're currently stuck to |
Procs | |
| apply_label | Applies a label to the name of what we're stuck to in the format of: "parent_name (label)" |
| clear_stick_to | General purpose / signal proc used to clear references and clean up when removed |
| interacted_with | This proc will trigger when any object is used to attack the thing we're stuck to. . |
| on_examine | This proc will trigger when someone examines the thing we're stuck to.
It will attach the text found in the body of the proc to the examine_list and display it to the player examining the parent. |
| on_peel | Callback invoked when the label is removed from something |
| on_stick | Callback invoked when the label is attached to something |
| reapply | Used to re-apply the label when the thing we're stuck to is renamed. |
| remove_label | Removes the label from the name of what we're stuck to |
| update_label_name | Sets the lable_name var and performs any necessary updates to the label's appearance |
Var Details
label_name
The text on the label
sticking_to
What atom we're currently stuck to
Proc Details
apply_label
Applies a label to the name of what we're stuck to in the format of: "parent_name (label)"
clear_stick_to
General purpose / signal proc used to clear references and clean up when removed
interacted_with
This proc will trigger when any object is used to attack the thing we're stuck to. .
If the attacking object is not a hand labeler, it will return. If the attacking object is a hand labeler, it will either update the label or remove the label entirely.
Arguments:
- source: The parent.
- attacker: The object that is hitting the parent.
- user: The mob who is wielding the attacking object.
on_examine
This proc will trigger when someone examines the thing we're stuck to.
It will attach the text found in the body of the proc to the examine_list and display it to the player examining the parent.
Arguments:
- source: The parent.
- user: The mob exmaining the parent.
- examine_list: The current list of text getting passed from the parent's normal examine() proc.
on_peel
Callback invoked when the label is removed from something
on_stick
Callback invoked when the label is attached to something
reapply
Used to re-apply the label when the thing we're stuck to is renamed.
remove_label
Removes the label from the name of what we're stuck to
update_label_name
Sets the lable_name var and performs any necessary updates to the label's appearance