fish

Vars
aquarium_vc_color	If present aquarium visual will be of this color
average_size	Average size for this fish type in centimeters. Will be used as gaussian distribution with 20% deviation for fishing, bought fish are always standard size
average_weight	Average weight for this fish type in grams
beauty	The beauty this fish provides to the aquarium it's inserted in.
breeding_timeout	How long it takes to produce new fish
breeding_wait	The time limit before new fish can be created
compatible_types	If set, the fish can also breed with these fishes types
death_text	The message shown when the fish dies.
dedicated_in_aquarium_icon	this icon file will be used for in-aquarium visual for the fish
dedicated_in_aquarium_icon_state	The icon_state that will be used for in-aquarium visual for the fish If not set, "[initial(icon_state)]_small" will be used instead
disliked_bait	Bait identifiers that make catching this fish harder and less likely Bait identifiers: Path \| Trait \| list("Type"="Foodtype","Value"= Food Type Flag like [MEAT])
do_flop_animation	If this fish should do the flopping animation
electrogenesis_cooldown	cooldown on creating tesla zaps
electrogenesis_power	power of the tesla zap created by the fish in a bioelectric generator
evolution_types	A list of possible evolutions. If set, offsprings may be of a different, new fish type if conditions are met.
experisci_scannable	If this fish type counts towards the Fish Species Scanning experiments
favorite_bait	Bait identifiers that make catching this fish easier and more likely Bait identifiers: Path \| Trait \| list("Type"="Foodtype","Value"= Food Type Flag like [MEAT])
feeding_frequency	How often the fish needs to be fed
fillet_type	Fish autogenerated from this behaviour will be processable into this
fish_movement_type	path to datums that dictate how the fish moves during the fishing minigame
fish_traits	List of fish trait types, these may modify probabilty/difficulty depending on rod/user properties or dictate how the fish behaves or some of its qualities.
fishing_difficulty_modifier	Base additive modifier to fishing difficulty
food	What type of reagent this fish needs to be fed.
grind_results	The grind results of the fish. They scale with the weight of the fish.
health	Current fish health. Dies at 0.
icon_state_dead	icon used when the fish is dead, ifset.
last_feeding	Time of last feedeing
min_pressure	Outside of an aquarium, the pressure needs to be within these two variables for the environment to be safe.
num_fillets	number of fillets given by the fish. It scales with its size.
random_case_rarity	How rare this fish is in the random cases
recently_petted	have we recently pet this fish
required_fluid_type	Required fluid type for this fish to live.
required_temperature_max	Maximum possible temperature for the fish to live.
required_temperature_min	Required minimum temperature for the fish to live.
safe_air_limits	When outside of an aquarium, these gases that are checked (as well as pressure and temp) to assert if the environment is safe or not.
show_in_catalog	Should this fish type show in fish catalog
size	Size in centimeters. Null until update_size_and_weight is called. Number of fillets and w_class scale with it.
sprite_height	height of aquarium visual icon
sprite_width	width of aquarium visual icon
stable_population	Won't breed more than this amount in single aquarium.
status	Fish status
weight	Weight in grams. Null until update_size_and_weight is called. Grind results scale with it. Don't think too hard how a trout could fit in a blender.
weight_size_deviation	The general deviation from the average weight and size this fish has in the wild
Procs
calculate_fish_force_bonus	A proc that makes the fish slightly stronger or weaker if there's a noticeable discrepancy between size and weight.
feed	Feed the fishes with the contents of the fish feed
flop_animation	This flopping animation played while the fish is alive.
get_export_price	Returns the price of this fish, for the fish export.
inherit_traits	This proc has fish_traits list populated with fish_traits paths from three different lists: traits from x_traits and y_traits are compared, and inserted if conditions are met; traits from fixed_traits are inserted unconditionally. traits from removed_traits will be removed from the for loop.
on_temp_animation	Refreshes flopping animation after temporary animation finishes
proper_environment	Checks if our current environment lets us live.
randomize_size_and_weight	Randomizes weight and size.
start_flopping	Starts flopping animation
stop_flopping	Stops flopping animation
update_fish_force	Reset weapon-related variables of this items and recalculates those values based on the fish weight and size.
update_size_and_weight	Updates weight and size, along with weight class, number of fillets you can get and grind results.

Var Details

var
aquarium_vc_color
–

If present aquarium visual will be of this color

var
average_size
–

Average size for this fish type in centimeters. Will be used as gaussian distribution with 20% deviation for fishing, bought fish are always standard size

var
average_weight
–

Average weight for this fish type in grams

var
beauty
–

The beauty this fish provides to the aquarium it's inserted in.

var
breeding_timeout
–

How long it takes to produce new fish

var
breeding_wait
–

The time limit before new fish can be created

var
compatible_types
– /list

If set, the fish can also breed with these fishes types

var
death_text
–

The message shown when the fish dies.

var
dedicated_in_aquarium_icon
–

this icon file will be used for in-aquarium visual for the fish

var
dedicated_in_aquarium_icon_state
–

The icon_state that will be used for in-aquarium visual for the fish If not set, "[initial(icon_state)]_small" will be used instead

var
disliked_bait
– /list

Bait identifiers that make catching this fish harder and less likely Bait identifiers: Path | Trait | list("Type"="Foodtype","Value"= Food Type Flag like [MEAT])

var
do_flop_animation
–

If this fish should do the flopping animation

var
electrogenesis_cooldown
–

cooldown on creating tesla zaps

var
electrogenesis_power
–

power of the tesla zap created by the fish in a bioelectric generator

var
evolution_types
– /list

A list of possible evolutions. If set, offsprings may be of a different, new fish type if conditions are met.

var
experisci_scannable
–

If this fish type counts towards the Fish Species Scanning experiments

var
favorite_bait
– /list

Bait identifiers that make catching this fish easier and more likely Bait identifiers: Path | Trait | list("Type"="Foodtype","Value"= Food Type Flag like [MEAT])

var
feeding_frequency
–

How often the fish needs to be fed

var
fillet_type
–

Fish autogenerated from this behaviour will be processable into this

var
fish_movement_type
–

path to datums that dictate how the fish moves during the fishing minigame

var
fish_traits
– /list

List of fish trait types, these may modify probabilty/difficulty depending on rod/user properties or dictate how the fish behaves or some of its qualities.

var
fishing_difficulty_modifier
–

Base additive modifier to fishing difficulty

var
food
– /datum/reagent

What type of reagent this fish needs to be fed.

↑
grind_results
– /list

The grind results of the fish. They scale with the weight of the fish.

var
health
–

Current fish health. Dies at 0.

var
icon_state_dead
–

icon used when the fish is dead, ifset.

var
last_feeding
–

Time of last feedeing

var
min_pressure
–

Outside of an aquarium, the pressure needs to be within these two variables for the environment to be safe.

var
num_fillets
–

number of fillets given by the fish. It scales with its size.

var
random_case_rarity
–

How rare this fish is in the random cases

var
recently_petted
–

have we recently pet this fish

var
required_fluid_type
–

Required fluid type for this fish to live.

var
required_temperature_max
–

Maximum possible temperature for the fish to live.

var
required_temperature_min
–

Required minimum temperature for the fish to live.

var
safe_air_limits
– /list

When outside of an aquarium, these gases that are checked (as well as pressure and temp) to assert if the environment is safe or not.

var
show_in_catalog
–

Should this fish type show in fish catalog

var
size
–

Size in centimeters. Null until update_size_and_weight is called. Number of fillets and w_class scale with it.

var
sprite_height
–

height of aquarium visual icon

var
sprite_width
–

width of aquarium visual icon

var
stable_population
–

Won't breed more than this amount in single aquarium.

var
status
–

Fish status

var
weight
–

Weight in grams. Null until update_size_and_weight is called. Grind results scale with it. Don't think too hard how a trout could fit in a blender.

var
weight_size_deviation
–

The general deviation from the average weight and size this fish has in the wild

Proc Details

proc
calculate_fish_force_bonus
(bonus_malus)

A proc that makes the fish slightly stronger or weaker if there's a noticeable discrepancy between size and weight.

proc
feed
(/datum/reagents/fed_reagents)

Feed the fishes with the contents of the fish feed

proc
flop_animation
()

This flopping animation played while the fish is alive.

proc
get_export_price
(price, percent)

Returns the price of this fish, for the fish export.

proc
inherit_traits
(/list/x_traits, /list/y_traits, /list/fixed_traits, /list/removed_traits)

This proc has fish_traits list populated with fish_traits paths from three different lists: traits from x_traits and y_traits are compared, and inserted if conditions are met; traits from fixed_traits are inserted unconditionally. traits from removed_traits will be removed from the for loop.

This proc should only be called if the fish was spawned with the apply_qualities arg set to FALSE and hasn't had inherited traits already.

proc
on_temp_animation
(/datum/source, animation_duration)

Refreshes flopping animation after temporary animation finishes

proc
proper_environment
()

Checks if our current environment lets us live.

proc
randomize_size_and_weight
(base_size, base_weight, deviation)

Randomizes weight and size.

proc
start_flopping
()

Starts flopping animation

proc
stop_flopping
()

Stops flopping animation

proc
update_fish_force
()

Reset weapon-related variables of this items and recalculates those values based on the fish weight and size.

proc
update_size_and_weight
(new_size, new_weight)

Updates weight and size, along with weight class, number of fillets you can get and grind results.

fish /obj/item/fish

Vars

Procs

Var Details

var aquarium_vc_color –

var average_size –

var average_weight –

var beauty –

var breeding_timeout –

var breeding_wait –

var compatible_types – /list

var death_text –

var dedicated_in_aquarium_icon –

var dedicated_in_aquarium_icon_state –

var disliked_bait – /list

var do_flop_animation –

var electrogenesis_cooldown –

var electrogenesis_power –

var evolution_types – /list

var experisci_scannable –

var favorite_bait – /list

var feeding_frequency –

var fillet_type –

var fish_movement_type –

var fish_traits – /list

var fishing_difficulty_modifier –

var food – /datum/reagent

↑grind_results – /list

var health –

var icon_state_dead –

var last_feeding –

var min_pressure –

var num_fillets –

var random_case_rarity –

var recently_petted –

var required_fluid_type –

var required_temperature_max –

var required_temperature_min –

var safe_air_limits – /list

var show_in_catalog –

var size –

var sprite_height –

var sprite_width –

var stable_population –

var status –

var weight –

var weight_size_deviation –