fish_analyzer

An item that can be used to gather information on the fish, such as but not limited to: health, hunger and traits.
Vars | |
| case_color | The color of the case. Used by grayscale configs and update_overlays() |
|---|---|
| fish_menu | The radial menu shown when analyzing aquariums. Having a persistent one allows us to update it whenever fish come and go, and is also required since we have a select callback used to check right clicks for scanning traits instead of status. |
| radial_choices | A cached list of the current choices for the aforedefined radial menu. |
Procs | |
| analyze_status | Called when a fish or a menu choice is left-clicked. This returns the fish's status, size, weight, feed type, hunger, breeding timeout. |
| analyze_traits | Called when a fish or a menu choice is left-clicked. This returns the fish's progenitors, traits and their inheritability. |
| can_select_fish | Whether the item should continue to show its radial menu or delete it. |
| choice_selected | Called when the user has selected a choice. If it's a right click, analyze the traits, else the status |
| delete_radial | Unregisters signals, delete the radial menu, unsets the choices. |
| on_aquarium_entered | Called when something enters the aquarium. If it's a fish, update the choices. |
| on_aquarium_exited | Called when something exits the aquarium. If it's a fish, update the choices. |
| radial_choices | Instantiates a radial menu choice datum for the current fish and adds it to the list of choices. |
| scan_aquarium | Instantiates the radial menu, populates the list of choices, shows it and register signals on the aquarium. |
Var Details
case_color

The color of the case. Used by grayscale configs and update_overlays()
fish_menu

The radial menu shown when analyzing aquariums. Having a persistent one allows us to update it whenever fish come and go, and is also required since we have a select callback used to check right clicks for scanning traits instead of status.
radial_choices

A cached list of the current choices for the aforedefined radial menu.
Proc Details
analyze_status
Called when a fish or a menu choice is left-clicked. This returns the fish's status, size, weight, feed type, hunger, breeding timeout.
analyze_traits
Called when a fish or a menu choice is left-clicked. This returns the fish's progenitors, traits and their inheritability.
can_select_fish
Whether the item should continue to show its radial menu or delete it.
choice_selected
Called when the user has selected a choice. If it's a right click, analyze the traits, else the status
delete_radial
Unregisters signals, delete the radial menu, unsets the choices.
on_aquarium_entered
Called when something enters the aquarium. If it's a fish, update the choices.
on_aquarium_exited
Called when something exits the aquarium. If it's a fish, update the choices.
radial_choices
Instantiates a radial menu choice datum for the current fish and adds it to the list of choices.
scan_aquarium
Instantiates the radial menu, populates the list of choices, shows it and register signals on the aquarium.