give
Vars | |
| additional_desc_text | Additional text displayed in the description of the alert. |
|---|---|
| offer | The offer we're linked to, yes this is suspiciously like a status effect alert |
Procs | |
| get_receiving_name | Called right before setup(), to do any sort of logic to change the name of
what's displayed as the name of what's being offered in the alert. Use this to
add pronouns and the like, or to totally override the displayed name!
Also the best place to make changes to additional_desc_text before setup()
without having to override setup() entirely. |
| handle_transfer | An overrideable proc used simply to hand over the item when claimed, this is a proc so that high-fives can override them since nothing is actually transferred |
| setup | Handles assigning most of the variables for the alert that pops up when an item is offered |
Var Details
additional_desc_text
Additional text displayed in the description of the alert.
offer
The offer we're linked to, yes this is suspiciously like a status effect alert
Proc Details
get_receiving_name
Called right before setup(), to do any sort of logic to change the name of
what's displayed as the name of what's being offered in the alert. Use this to
add pronouns and the like, or to totally override the displayed name!
Also the best place to make changes to additional_desc_text before setup()
without having to override setup() entirely.
Arguments:
- taker - The person receiving the alert
- offerer - The person giving the alert and item
- receiving - The item being given by the offerer
Returns a string that will be displayed in the alert, which is receiving.name
by default.
handle_transfer
An overrideable proc used simply to hand over the item when claimed, this is a proc so that high-fives can override them since nothing is actually transferred
setup
Handles assigning most of the variables for the alert that pops up when an item is offered
Handles setting the name, description and icon of the alert and tracking the person giving and the item being offered. Arguments:
- taker - The person receiving the alert
- offerer - The person giving the alert and item
- receiving - The item being given by the offerer