click_handler ![code/_onclick/click_handling.dm 30](git.png)
Vars | |
flags | Bitfield (Any of CLICK_HANDLER_* ). Relevant flags to control the logic flow of this click handler. |
---|---|
user | The mob this click handler is attached to. |
Procs | |
Enter | Called when the click handler becomes the active entry in the mob's click handlers list. Called by
PushClickHandler() and RemoveClickHandler() . |
Exit | Called when the click handler was active in the mob's click handler list and has been replaced by another handler or
otherwise removed. Called by PushClickHandler() and RemoveClickHandler() . |
OnClick | Called on click by /atom/Click() when this is the mob's currently active click handler. |
OnDblClick | Called on doubleclick by /atom/DblClick() when this is the mob's currently active click handler. |
OnMobLogout | Event proc for logged_out_event . Called when the mob logs out and this click handler has the
CLICK_HANDLER_REMOVE_ON_MOB_LOGOUT flag set. |
Var Details
flags ![code/_onclick/click_handling.dm 39](git.png)
Bitfield (Any of CLICK_HANDLER_*
). Relevant flags to control the logic flow of this click handler.
See code\_onclick\click_handling.dm
for valid options.
user ![code/_onclick/click_handling.dm 32](git.png)
The mob this click handler is attached to.
Proc Details
Enter
Called when the click handler becomes the active entry in the mob's click handlers list. Called by
PushClickHandler()
and RemoveClickHandler()
.
Has no return value.
Exit
Called when the click handler was active in the mob's click handler list and has been replaced by another handler or
otherwise removed. Called by PushClickHandler()
and RemoveClickHandler()
.
Has no return value.
OnClick
Called on click by /atom/Click()
when this is the mob's currently active click handler.
Parameters:
A
- The atom clicked on.params
(list of strings) - List of click parameters. See BYOND'sCLick()
documentation.
Has no return value.
OnDblClick
Called on doubleclick by /atom/DblClick()
when this is the mob's currently active click handler.
Parameters:
A
- The atom double clicked on.params
(list of strings) - List of click parameters. See BYOND'sCLick()
documentation.
Has no return value.
OnMobLogout
Event proc for logged_out_event
. Called when the mob logs out and this click handler has the
CLICK_HANDLER_REMOVE_ON_MOB_LOGOUT
flag set.
By default, this removes the click handler from the assigned mob.
Has no return value.