fishing_challenge

Vars
active_effect_cd	The cooldown between switching active effects
active_effects	A list of possible active minigame effects. If not empty, one will be picked from time to time.
background	Background icon state from fishing_hud.dmi
bait_bounce_mult	By how much the bait recoils back when hitting the bounds of the slider while idle
bait_height	How much space the bait takes on the minigame slider
bait_pixel_height	The height in pixels of the bait bar
bait_position	The position of the bait on the minigame slider
bait_velocity	The current speed the bait is moving at
completed	Is it finished (either by win/lose or window closing)
completion	The completion score. If it reaches 100, it's a win. If it reaches 0, it's a loss.
completion_gain	How much completion is gained per second when the bait area is intersecting with the fish's
completion_loss	How much completion is lost per second when the bait area is not intersecting with the fish's
current_active_effect	The current active effect
deceleration_mult	The multiplier of deceleration of velocity that happens when the bait switches direction
difficulty	Minigame difficulty
fish_height	How much space the fish takes on the minigame slider
fish_icon	Fish icon state from fishing_hud.dmi
fish_pixel_height	The height in pixels of the fish
fish_position	The position of the fish on the minigame slider
fish_source	Keep track of the fish source from which we're pulling the reward
fishing_hud	The background as shown in the minigame, and the holder of the other visual overlays
fishing_line	Fishing line visual
float	float visual
gravity_velocity	The acceleration of the bait while not reeling
last_baiting_click	The last time we clicked during the baiting phase
location	The physical fishing spot our float is hovering
next_phase_timer	Timer for the next phase
phase	Current phase
reeling_state	Whether the bait is idle or reeling up or down (left and right click)
reeling_velocity	The acceleration of the bait while reeling
reward_path	Result path
special_effects	Rule modifiers (eg weighted bait)
start_time	When the ui minigame phase started
used_rod	Rod that is used for the challenge
user	Fishing mob
wait_time_range	The lower and upper bounds of the waiting phase timer
Procs
get_stack_trace	Throws a stack with prefixed text.
interrupt	Challenge interrupted by something external
is_fish_on_bait	Returns TRUE if the fish and the bait are intersecting
move_bait	The proc that moves the bait around, just like in the old TGUI, mostly.
on_user_logout	The player is no longer around to play the minigame, so we interrupt it.
prepare_minigame_hud	Initialize the minigame hud and register some signals to make it work.
process	Update the state of the fish, the bait and the hud
register_reward_signals	Proc responsible for registering the signals for difficulty and possible reward. Call this if you want to override the fish source from which we roll rewards (preferably before the minigame phase).
remove_minigame_hud	Stop processing and remove references to the minigame hud
select_active_effect	The proc that handles fancy effects like flipping the hud or skewing movement
set_lure_timers	Set the timers for lure that need to be spun at intervals.
start_minigame_phase	Get the difficulty and other variables, than start the minigame
start_reeling	While the mouse button is held down, the bait will be reeling up (or down on r-click if the bidirectional rule is enabled)
stop_reeling	Reset the reeling state to idle once the mouse button is released
update_visuals	update the vertical pixel position of both fish and bait, and the icon state of the completion bar

Var Details

var
active_effect_cd
–

The cooldown between switching active effects

var
active_effects
– /list

A list of possible active minigame effects. If not empty, one will be picked from time to time.

var
background
–

Background icon state from fishing_hud.dmi

var
bait_bounce_mult
–

By how much the bait recoils back when hitting the bounds of the slider while idle

var
bait_height
–

How much space the bait takes on the minigame slider

var
bait_pixel_height
–

The height in pixels of the bait bar

var
bait_position
–

The position of the bait on the minigame slider

var
bait_velocity
–

The current speed the bait is moving at

var
completed
–

Is it finished (either by win/lose or window closing)

var
completion
–

The completion score. If it reaches 100, it's a win. If it reaches 0, it's a loss.

var
completion_gain
–

How much completion is gained per second when the bait area is intersecting with the fish's

var
completion_loss
–

How much completion is lost per second when the bait area is not intersecting with the fish's

var
current_active_effect
–

The current active effect

var
deceleration_mult
–

The multiplier of deceleration of velocity that happens when the bait switches direction

var
difficulty
–

Minigame difficulty

var
fish_height
–

How much space the fish takes on the minigame slider

var
fish_icon
–

Fish icon state from fishing_hud.dmi

var
fish_pixel_height
–

The height in pixels of the fish

var
fish_position
–

The position of the fish on the minigame slider

var
fish_source
– /datum/fish_source

Keep track of the fish source from which we're pulling the reward

var
fishing_hud
– /atom/movable/screen/fishing_hud

The background as shown in the minigame, and the holder of the other visual overlays

var
fishing_line
– /datum/beam

Fishing line visual

var
float
– /obj/effect/fishing_float

float visual

var
gravity_velocity
–

The acceleration of the bait while not reeling

var
last_baiting_click
–

The last time we clicked during the baiting phase

var
location
– /atom

The physical fishing spot our float is hovering

var
next_phase_timer
–

Timer for the next phase

var
phase
–

Current phase

var
reeling_state
–

Whether the bait is idle or reeling up or down (left and right click)

var
reeling_velocity
–

The acceleration of the bait while reeling

var
reward_path
–

Result path

var
special_effects
–

Rule modifiers (eg weighted bait)

var
start_time
–

When the ui minigame phase started

var
used_rod
– /obj/item/fishing_rod

Rod that is used for the challenge

var
user
– /mob

Fishing mob

var
wait_time_range
– /list

The lower and upper bounds of the waiting phase timer

Proc Details

proc
get_stack_trace
(init_text)

Throws a stack with prefixed text.

proc
interrupt
()

Challenge interrupted by something external

proc
is_fish_on_bait
()

Returns TRUE if the fish and the bait are intersecting

proc
move_bait
(seconds_per_tick)

The proc that moves the bait around, just like in the old TGUI, mostly.

proc
on_user_logout
(/datum/source)

The player is no longer around to play the minigame, so we interrupt it.

proc
prepare_minigame_hud
()

Initialize the minigame hud and register some signals to make it work.

↑
process
(seconds_per_tick)

Update the state of the fish, the bait and the hud

proc
register_reward_signals
(/datum/fish_source/fish_source)

Proc responsible for registering the signals for difficulty and possible reward. Call this if you want to override the fish source from which we roll rewards (preferably before the minigame phase).

proc
remove_minigame_hud
()

Stop processing and remove references to the minigame hud

proc
select_active_effect
()

The proc that handles fancy effects like flipping the hud or skewing movement

proc
set_lure_timers
()

Set the timers for lure that need to be spun at intervals.

proc
start_minigame_phase
(auto_reel)

Get the difficulty and other variables, than start the minigame

proc
start_reeling
(/client/source, /datum/object, location, control, params)

While the mouse button is held down, the bait will be reeling up (or down on r-click if the bidirectional rule is enabled)

proc
stop_reeling
(/client/source, /datum/object, location, control, params)

Reset the reeling state to idle once the mouse button is released

proc
update_visuals
()

update the vertical pixel position of both fish and bait, and the icon state of the completion bar

fishing_challenge /datum/fishing_challenge

Vars

Procs

Var Details

var active_effect_cd –

var active_effects – /list

var background –

var bait_bounce_mult –

var bait_height –

var bait_pixel_height –

var bait_position –

var bait_velocity –

var completed –

var completion –

var completion_gain –

var completion_loss –

var current_active_effect –

var deceleration_mult –

var difficulty –

var fish_height –

var fish_icon –

var fish_pixel_height –

var fish_position –

var fish_source – /datum/fish_source

var fishing_hud – /atom/movable/screen/fishing_hud

var fishing_line – /datum/beam

var float – /obj/effect/fishing_float

var gravity_velocity –

var last_baiting_click –

var location – /atom

var next_phase_timer –

var phase –

var reeling_state –

var reeling_velocity –

var reward_path –

var special_effects –

var start_time –

var used_rod – /obj/item/fishing_rod

var user – /mob

var wait_time_range – /list