aquarium_content

Allows movables to be inserted/displayed in aquariums.

Vars
animation_getter	Proc used to retrieve current animation state from the parent, optional
animation_update_signals	Signals of the parent that will trigger animation update
aquarium_vc_color	Applied to vc object only for use with greyscaled icons.
base_px	Base px offset of the visual object in current aquarium aka current base position
base_py	Base px offset of the visual object in current aquarium aka current base position
base_transform	Transformation applied to the visual holder - used when scaled down sprites are used as in aquarium visual
current_animation	Currently playing animation
current_aquarium	Keeps track of our current aquarium.
icon	Fish sprite how to: Need to be centered on 16,16 in the dmi and facing left by default. sprite_height/sprite_width is the size it will have in aquarium and used to control animation boundaries. source_height/source_width is the size of the original icon (ideally only the non-empty parts) Icon used for in aquarium sprite
icon_state	If this is set this icon state will be used for the holder while icon_state will only be used for item/catalog. Transformation from source_width/height WON'T be applied.
layer_mode	How the thing will be layered
processing	Does this behviour need additional processing in aquarium, will be added to SSobj processing on insertion
randomize_position	If the starting position is randomised within bounds when inserted into aquarium.
unique	TODO: Change this into trait checked on aquarium insertion
Procs
InitializeFromFish	Sets visuals properties for fish
InitializeFromProp	Sets visuals properties for fish
InitializeOther	Mostly for admin abuse
apply_appearance	Applies icon,color and base scaling to our visual holder
generate_animation	Actually animates the vc holder
generate_base_vc	Generates common visual object, propeties that don't depend on aquarium surface
on_surface_changed	Aquarium surface changed in some way, we need to recalculate base position and aninmation
swim_animation	Create looping random path animation, pixel offsets parameters include offsets already

Var Details

var
animation_getter

Proc used to retrieve current animation state from the parent, optional

var
animation_update_signals

Signals of the parent that will trigger animation update

var
aquarium_vc_color

Applied to vc object only for use with greyscaled icons.

var
base_px

Base px offset of the visual object in current aquarium aka current base position

var
base_py

Base px offset of the visual object in current aquarium aka current base position

var
base_transform
– /matrix

Transformation applied to the visual holder - used when scaled down sprites are used as in aquarium visual

var
current_animation

Currently playing animation

var
current_aquarium
– /obj/structure/aquarium

Keeps track of our current aquarium.

var
icon

Fish sprite how to: Need to be centered on 16,16 in the dmi and facing left by default. sprite_height/sprite_width is the size it will have in aquarium and used to control animation boundaries. source_height/source_width is the size of the original icon (ideally only the non-empty parts) Icon used for in aquarium sprite

var
icon_state

If this is set this icon state will be used for the holder while icon_state will only be used for item/catalog. Transformation from source_width/height WON'T be applied.

var
layer_mode

How the thing will be layered

var
processing

Does this behviour need additional processing in aquarium, will be added to SSobj processing on insertion

var
randomize_position

If the starting position is randomised within bounds when inserted into aquarium.

var
unique

TODO: Change this into trait checked on aquarium insertion

Proc Details

proc
InitializeFromFish
()

Sets visuals properties for fish

proc
InitializeFromProp
()

Sets visuals properties for fish

proc
InitializeOther
()

Mostly for admin abuse

proc
apply_appearance
(/obj/effect/holder)

Applies icon,color and base scaling to our visual holder

proc
generate_animation
(reset)

Actually animates the vc holder

proc
generate_base_vc
()

Generates common visual object, propeties that don't depend on aquarium surface

proc
on_surface_changed
()

Aquarium surface changed in some way, we need to recalculate base position and aninmation

proc
swim_animation
()

Create looping random path animation, pixel offsets parameters include offsets already

aquarium_content /datum/component/aquarium_content

Vars

Procs

Var Details

var animation_getter

var animation_update_signals

var aquarium_vc_color

var base_px

var base_py

var base_transform – /matrix

var current_animation

var current_aquarium – /obj/structure/aquarium

var icon

var icon_state

var layer_mode

var processing

var randomize_position

var unique