points_of_interest
Vars | |
| mob_points_of_interest | List of mob POIs. This list is automatically sorted. |
|---|---|
| narsies | Special helper list to track any Nar'sies. |
| other_points_of_interest | List of non-mob POIs. This list is automatically sorted. |
| points_of_interest_by_target_ref | List of all value:POI datums by their key:target refs. |
| real_nuclear_disks | Special helper list of all real nuke disks. |
Procs | |
| get_mob_pois | Returns a list of mob POIs with names as keys and mobs as values. |
| get_other_pois | Returns a list of non-mob POIs with names as keys and atoms as values. |
| get_poi_atom_by_ref | If there is a valid POI for a given reference, it returns that POI's associated atom. Otherwise, it returns null. |
| is_valid_poi | Returns TRUE if potential_poi has an associated poi_datum that validates. |
| make_point_of_interest | Turns new_poi into a new point of interest by adding the /datum/element/point_of_interest element to it. |
| on_poi_element_added | Called by /datum/element/point_of_interest when it gets removed from old_poi. |
| on_poi_element_removed | Called by /datum/element/point_of_interest when it gets removed from old_poi. |
| remove_point_of_interest | Stops old_poi from being a point of interest by removing the /datum/element/point_of_interest element from it. |
Var Details
mob_points_of_interest
List of mob POIs. This list is automatically sorted.
narsies
Special helper list to track any Nar'sies.
other_points_of_interest
List of non-mob POIs. This list is automatically sorted.
points_of_interest_by_target_ref
List of all value:POI datums by their key:target refs.
real_nuclear_disks
Special helper list of all real nuke disks.
Proc Details
get_mob_pois
Returns a list of mob POIs with names as keys and mobs as values.
If multiple POIs have the same name, then avoid_assoc_duplicate_keys is used alongside used_name_list to tag them as Mob Name (1), Mob Name (2), Mob Name (3) etc.
Arguments:
- poi_validation_override - [OPTIONAL] Callback to a proc that takes a single argument for the POI and returns TRUE if this POI should be included. Overrides standard POI validation.
- append_dead_role - [OPTIONAL] If TRUE, adds a ghost tag to the end of observer names and a dead tag to the end of any other mob which is not alive.
get_other_pois
Returns a list of non-mob POIs with names as keys and atoms as values.
If multiple POIs have the same name, then avoid_assoc_duplicate_keys is used alongside used_name_list to tag them as Object Name (1), Object Name (2), Object Name (3) etc.
Arguments:
- poi_validation_override - [OPTIONAL] Callback to a proc that takes a single argument for the POI and returns TRUE if this POI should be included. Overrides standard POI validation.
get_poi_atom_by_ref
If there is a valid POI for a given reference, it returns that POI's associated atom. Otherwise, it returns null.
is_valid_poi
Returns TRUE if potential_poi has an associated poi_datum that validates.
make_point_of_interest
Turns new_poi into a new point of interest by adding the /datum/element/point_of_interest element to it.
on_poi_element_added
Called by /datum/element/point_of_interest when it gets removed from old_poi.
on_poi_element_removed
Called by /datum/element/point_of_interest when it gets removed from old_poi.
remove_point_of_interest
Stops old_poi from being a point of interest by removing the /datum/element/point_of_interest element from it.