fishing_rod

Vars
bait_height_mult	The multiplier of the bait height. Influenced by the strength_modifier of a material, unlike the other variables, lest we add too many vars to materials. Also materials with a strength_modifier lower than 1 don't do anything, since they're already likely to be quite bad
bait_speed_mult	The multiplier of the speed of the bobber/bait during the minigame
bounciness_mult	The multiplier of the bounciness of the bobber/bait upon hitting the edges of the minigame area
cast_range	How far can you cast this
casting	Are we currently casting
casting_cd	Prevents spamming the line casting, without affecting the player's click cooldown.
completion_speed_mult	The multiplier of the completion gain during the minigame
currently_hooked	Currently hooked item for item reeling
deceleration_mult	The multiplier of the decelaration during the minigame
default_line_color	The default color for the reel overlay if no line is equipped.
difficulty_modifier	Fishing minigame difficulty modifier (additive)
experience_multiplier	The multiplier of how much experience is gained when fishing with this rod.
fishing_line	Fishing line visual for the hooked item
frame_state	Icon state of the frame overlay this rod uses for the minigame
gravity_mult	The multiplier of negative velocity that pulls the bait/bobber down when not holding the click
internal	Is this currently being used by the profound fisher component?
material_fish_chance	The chance of catching fish made of the same material of the fishing rod (if MATERIAL_EFFECTS is enabled)
reel_overlay	The name of the icon state of the reel overlay
show_in_wiki	Is this fishing rod shown in the wiki
spin_frequency	A list with two keys delimiting the spinning interval in which a mouse click has to be pressed while fishing. Inherited from baits, passed down to the minigame lure.
ui_description	Explaination of rod functionality shown in the ui and the autowiki
wiki_description	More explaination shown in the wiki after ui_description
Procs
attempt_bane	Fishing rodss should only bane fish DNA-infused spessman
bane_effects	Fishing rods should hard-counter fish DNA-infused spessman
cast_line	If the line to whatever that is is clear and we're not already busy, try fishing in it
create_fishing_line	Generates the fishing line visual from the current user to the target and updates inhands
get_material_fish_chance	Returns the probability that a fish caught by this (custom material) rod will be of the same material.
get_stat_info	Used in examine_more to reduce all the copypasta when getting more information about the various stats of the fishing rod.
hook_hit	Called by hook projectile when hitting things
hook_item	Hooks the item
on_reward_caught	Called at the end of on_challenge_completed() once the reward has been spawned
reason_we_cant_fish	Is there a reason why this fishing rod couldn't fish in target_fish_source? If so, return the denial reason as a string, otherwise return `null`.
set_slot	assign an item to the given slot and its standard effects, while Exited() should handle unsetting the slot.
slot_check	Checks if the item fits the slot
use_slot	Ideally this will be replaced with generic slotted storage datum + display

Var Details

var
bait_height_mult

The multiplier of the bait height. Influenced by the strength_modifier of a material, unlike the other variables, lest we add too many vars to materials. Also materials with a strength_modifier lower than 1 don't do anything, since they're already likely to be quite bad

var
bait_speed_mult

The multiplier of the speed of the bobber/bait during the minigame

var
bounciness_mult

The multiplier of the bounciness of the bobber/bait upon hitting the edges of the minigame area

var
cast_range

How far can you cast this

var
casting

Are we currently casting

var
casting_cd

Prevents spamming the line casting, without affecting the player's click cooldown.

var
completion_speed_mult

The multiplier of the completion gain during the minigame

var
currently_hooked
– /atom/movable

Currently hooked item for item reeling

var
deceleration_mult

The multiplier of the decelaration during the minigame

var
default_line_color

The default color for the reel overlay if no line is equipped.

var
difficulty_modifier

Fishing minigame difficulty modifier (additive)

var
experience_multiplier

The multiplier of how much experience is gained when fishing with this rod.

var
fishing_line
– /datum/beam/fishing_line

Fishing line visual for the hooked item

var
frame_state

Icon state of the frame overlay this rod uses for the minigame

var
gravity_mult

The multiplier of negative velocity that pulls the bait/bobber down when not holding the click

var
internal

Is this currently being used by the profound fisher component?

var
material_fish_chance

The chance of catching fish made of the same material of the fishing rod (if MATERIAL_EFFECTS is enabled)

var
reel_overlay

The name of the icon state of the reel overlay

var
show_in_wiki

Is this fishing rod shown in the wiki

var
spin_frequency
– /list

A list with two keys delimiting the spinning interval in which a mouse click has to be pressed while fishing. Inherited from baits, passed down to the minigame lure.

var
ui_description

Explaination of rod functionality shown in the ui and the autowiki

var
wiki_description

More explaination shown in the wiki after ui_description

Proc Details

proc
attempt_bane
(/datum/source, /mob/living/fish)

Fishing rodss should only bane fish DNA-infused spessman

proc
bane_effects
(/datum/source, /mob/living/fish)

Fishing rods should hard-counter fish DNA-infused spessman

proc
cast_line
(/atom/target, /mob/user)

If the line to whatever that is is clear and we're not already busy, try fishing in it

proc
create_fishing_line
(/atom/movable/target, /mob/living/firer, target_py)

Generates the fishing line visual from the current user to the target and updates inhands

proc
get_material_fish_chance
(/mob/user)

Returns the probability that a fish caught by this (custom material) rod will be of the same material.

proc
get_stat_info
(get_percent, value, prefix, easier, harder, suffix, span_info, less_is_better, offset)

Used in examine_more to reduce all the copypasta when getting more information about the various stats of the fishing rod.

proc
hook_hit
(/atom/atom_hit_by_hook_projectile, /mob/user)

Called by hook projectile when hitting things

proc
hook_item
(/mob/user, /atom/target_atom)

Hooks the item

proc
on_reward_caught
(/atom/movable/reward, /mob/user)

Called at the end of on_challenge_completed() once the reward has been spawned

proc
reason_we_cant_fish
(/datum/fish_source/target_fish_source)

Is there a reason why this fishing rod couldn't fish in target_fish_source? If so, return the denial reason as a string, otherwise return null.

Arguments:

target_fish_source - The /datum/fish_source we're trying to fish in.

proc
set_slot
(/obj/item/equipment, slot)

assign an item to the given slot and its standard effects, while Exited() should handle unsetting the slot.

proc
slot_check
(/obj/item/item, slot)

Checks if the item fits the slot

proc
use_slot
(slot, /mob/user, /obj/item/new_item)

Ideally this will be replaced with generic slotted storage datum + display

fishing_rod /obj/item/fishing_rod

Vars

Procs

Var Details

var bait_height_mult

var bait_speed_mult

var bounciness_mult

var cast_range

var casting

var casting_cd

var completion_speed_mult

var currently_hooked – /atom/movable

var deceleration_mult

var default_line_color

var difficulty_modifier

var experience_multiplier

var fishing_line – /datum/beam/fishing_line

var frame_state

var gravity_mult

var internal

var material_fish_chance

var reel_overlay

var show_in_wiki

var spin_frequency – /list

var ui_description

var wiki_description