/tg/ Station 13 - Modules - TypesVar Details - Proc Details

aquarium_behaviour

Vars

aquarium_vc_colorApplied to vc object only for use with greyscaled icons.
colorApplied and item/catalog for use with greyscaled icons.
current_animationCurrent animation
dedicated_in_aquarium_icon_stateFish 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) 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.
icon_stateIcon state used for catalog/autogenerated fish item. Also used as basis for in aquarium visual if dedicated_in_aquarium_icon_state is not set.
layer_modeHow the thing will be layered
parentOur holder component
processingDoes this behviour need additional processing in aquarium, will be added to SSobj processing on insertion
randomize_positionIf the starting position is randomised within bounds.

Procs

apply_appearanceApplies icon,color and base scaling to our visual holder
before_removalCalled just before the object gets removed from the aquarium
on_feedingCalled when fed.
on_fluid_changedCalled when aquarium fluid changes.
on_insertedCalled when inserted into new aquarium
update_animationCalled to update current animation based on state

Var Details

aquarium_vc_color

Applied to vc object only for use with greyscaled icons.

color

Applied and item/catalog for use with greyscaled icons.

current_animation

Current animation

dedicated_in_aquarium_icon_state

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

icon_state

Icon state used for catalog/autogenerated fish item. Also used as basis for in aquarium visual if dedicated_in_aquarium_icon_state is not set.

layer_mode

How the thing will be layered

parent

Our holder component

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.

Proc Details

apply_appearance

Applies icon,color and base scaling to our visual holder

before_removal

Called just before the object gets removed from the aquarium

on_feeding

Called when fed.

on_fluid_changed

Called when aquarium fluid changes.

on_inserted

Called when inserted into new aquarium

update_animation

Called to update current animation based on state