Goonstation 13 - Modules - TypesVar Details - Proc Details

/atom/movable/maptext_manager

Maptext manager atom/movables govern displaying maptext over single parent atom. To this end, they track the outermost movable of the parent atom, and relocate to the outermost loc if possible. To display maptext to a client, the list of maptext holders indexed by their associated clients is queried for the maptext holder associated with that client, and instructed to add a line.

Vars

maptext_holders_by_clientA list of maptext holders belonging to this maptext manager, indexed by their associated clients.
parentThe atom that this maptext manager belongs to.
registeredWhether this maptext manager is registered to the XSIG_OUTERMOST_MOVABLE_CHANGED complex signal.

Procs

add_maptextAdds a line of maptext to the maptext holder associated with the specified client, displaying the maptext over the parent atom.
notify_emptyNotifies this maptext manager that the maptext holder of the specified client is empty. If all maptext holders are empty, the XSIG_OUTERMOST_MOVABLE_CHANGED complex signal is unregistered.
notify_nonemptyNotifies this maptext manager that a maptext holder is nonempty, requiring it to register the XSIG_OUTERMOST_MOVABLE_CHANGED complex signal if not already done so.
update_outermost_movableUpdate the loc of this maptext manager to specified new outermost movable. Used with XSIG_OUTERMOST_MOVABLE_CHANGED.

Var Details

maptext_holders_by_client

A list of maptext holders belonging to this maptext manager, indexed by their associated clients.

parent

The atom that this maptext manager belongs to.

registered

Whether this maptext manager is registered to the XSIG_OUTERMOST_MOVABLE_CHANGED complex signal.

Proc Details

add_maptext

Adds a line of maptext to the maptext holder associated with the specified client, displaying the maptext over the parent atom.

notify_empty

Notifies this maptext manager that the maptext holder of the specified client is empty. If all maptext holders are empty, the XSIG_OUTERMOST_MOVABLE_CHANGED complex signal is unregistered.

notify_nonempty

Notifies this maptext manager that a maptext holder is nonempty, requiring it to register the XSIG_OUTERMOST_MOVABLE_CHANGED complex signal if not already done so.

update_outermost_movable

Update the loc of this maptext manager to specified new outermost movable. Used with XSIG_OUTERMOST_MOVABLE_CHANGED.