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
can_interrupt_move	If true, the fish can jump while a target position is set, thus overriding it
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
current_velocity_limit	The current speed limit used
difficulty	Minigame difficulty
fish_ai	Fish AI type to use
fish_height	How much space the fish takes on the minigame slider
fish_icon	Fish icon state from fishing_hud.dmi
fish_idle_velocity	The base velocity of the fish, which may affect jump distances and falling speed.
fish_pixel_height	The height in pixels of the fish
fish_position	The position of the fish on the minigame slider
fish_velocity	The current speed the fish is moving at
fishing_hud	The background as shown in the minigame, and the holder of the other visual overlays
fishing_line	Fishing line visual
gravity_velocity	The acceleration of the bait while not reeling
long_jump_chance	How likely the fish is to perform a long jump, then multiplied by difficulty
long_jump_velocity_limit	The speed limit for the long jump
lure	Lure visual
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
short_jump_chance	How likely the fish is to perform a standard jump, then multiplied by difficulty
short_jump_velocity_limit	The speed limit for the short jump
special_effects	Rule modifiers (eg weighted bait)
start_time	When the ui minigame phase started
target_position	A position on the slider the fish wants to get to
used_rod	Rod that is used for the challenge
user	Fishing mob
Procs
Destroy	Fish minigame properties Enable special parameters If the chances are higher than 1% (100% at maximum difficulty), they'll scale less than proportionally (exponent less than 1) instead. This way we ensure fish with high jump chances won't get TOO jumpy until they near the maximum difficulty, at which they hit 100%
handle_click	The lure may be out of sight if the user has moed around a corner, so the message should be displayed over him instead.
interrupt	Challenge interrupted by something external
move_bait	Move at least 0.75 to full of the availible bar in given direction, and more likely to move in the direction where there's more space The proc that moves the bait around, just like in the old TGUI, mostly.
move_fish	bring forth an active effect go back to normal The proc that moves the fish around, just like in the old TGUI, mostly.
on_line_deleted	Create fishing line visuals
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
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
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	Pull the brake on the velocity if the current velocity and the acceleration have different directions, making the bait less slippery, thus easier to control bidirectional baits stay bouyant while idle 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
can_interrupt_move
–

If true, the fish can jump while a target position is set, thus overriding it

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
current_velocity_limit
–

The current speed limit used

var
difficulty
–

Minigame difficulty

var
fish_ai
–

Fish AI type to use

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_idle_velocity
–

The base velocity of the fish, which may affect jump distances and falling speed.

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_velocity
–

The current speed the fish is moving at

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
gravity_velocity
–

The acceleration of the bait while not reeling

var
long_jump_chance
–

How likely the fish is to perform a long jump, then multiplied by difficulty

var
long_jump_velocity_limit
–

The speed limit for the long jump

var
lure
– /obj/effect/fishing_lure

Lure visual

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
short_jump_chance
–

How likely the fish is to perform a standard jump, then multiplied by difficulty

var
short_jump_velocity_limit
–

The speed limit for the short jump

var
special_effects
–

Rule modifiers (eg weighted bait)

var
start_time
–

When the ui minigame phase started

var
target_position
–

A position on the slider the fish wants to get to

var
used_rod
– /obj/item/fishing_rod

Rod that is used for the challenge

var
user
– /mob

Fishing mob

Proc Details

↑
Destroy
(force, ...)

Fish minigame properties Enable special parameters If the chances are higher than 1% (100% at maximum difficulty), they'll scale less than proportionally (exponent less than 1) instead. This way we ensure fish with high jump chances won't get TOO jumpy until they near the maximum difficulty, at which they hit 100%

proc
handle_click
(/mob/source, /atom/target, modifiers)

The lure may be out of sight if the user has moed around a corner, so the message should be displayed over him instead.

proc
interrupt
()

Challenge interrupted by something external

proc
move_bait
(seconds_per_tick)

Move at least 0.75 to full of the availible bar in given direction, and more likely to move in the direction where there's more space The proc that moves the bait around, just like in the old TGUI, mostly.

proc
move_fish
(seconds_per_tick)

bring forth an active effect go back to normal The proc that moves the fish around, just like in the old TGUI, mostly.

proc
on_line_deleted
(/datum/source)

Create fishing line visuals

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
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
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
()

Pull the brake on the velocity if the current velocity and the acceleration have different directions, making the bait less slippery, thus easier to control bidirectional baits stay bouyant while idle 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 can_interrupt_move –

var completed –

var completion –

var completion_gain –

var completion_loss –

var current_active_effect –

var current_velocity_limit –

var difficulty –

var fish_ai –

var fish_height –

var fish_icon –

var fish_idle_velocity –

var fish_pixel_height –

var fish_position –

var fish_velocity –

var fishing_hud – /atom/movable/screen/fishing_hud

var fishing_line – /datum/beam

var gravity_velocity –

var long_jump_chance –

var long_jump_velocity_limit –

var lure – /obj/effect/fishing_lure

var reeling_state –

var reeling_velocity –

var reward_path –

var short_jump_chance –

var short_jump_velocity_limit –

var special_effects –

var start_time –

var target_position –

var used_rod – /obj/item/fishing_rod

var user – /mob