TileTransitions - Prototype Docs

TileTransitions :: struct

Use layout with spritesheet to define all the tile layers inside the layout property. The *_enabled, *_layout and *_spritesheet properties can be used to override specific layers of a reused layout.

Children

Properties

default

sorted

layout optional	:: TileTransitionSpritesheetLayout
spritesheet optional	:: FileName	Default spritesheet for all TileSpriteLayouts.
Default spritesheet for all TileSpriteLayouts.
overlay_enabled optional	:: boolean
mask_enabled optional	:: boolean
background_enabled optional	:: boolean
background_mask_enabled optional	:: boolean
effect_map_enabled optional	:: boolean
lightmap_enabled optional	:: boolean
auxiliary_effect_mask_enabled optional	:: boolean
overlay_layout optional	:: TileTransitionVariantLayout	Overrides the `overlay` definition inside `layout`.
Overrides the `overlay` definition inside `layout`.
mask_layout optional	:: TileTransitionVariantLayout	Overrides the `mask` definition inside `layout`.
Overrides the `mask` definition inside `layout`.
background_layout optional	:: TileTransitionVariantLayout	Overrides the `background` definition inside `layout`.
Overrides the `background` definition inside `layout`.
background_mask_layout optional	:: TileTransitionVariantLayout	Overrides the `background_mask` definition inside `layout`.
Overrides the `background_mask` definition inside `layout`.
effect_map_layout optional	:: TileTransitionVariantLayout	Overrides the `effect_map` definition inside `layout`.
Overrides the `effect_map` definition inside `layout`.
lightmap_layout optional	:: TileTransitionVariantLayout	Overrides the `lightmap` definition inside `layout`.
Overrides the `lightmap` definition inside `layout`.
auxiliary_effect_mask_layout optional	:: TileTransitionVariantLayout	Overrides the `auxiliary_effect_mask` definition inside `layout`.
Overrides the `auxiliary_effect_mask` definition inside `layout`.
mask_spritesheet optional	:: FileName	Only loaded if `layout` or `mask_layout` is defined. [...]
Only loaded if `layout` or `mask_layout` is defined. [...]
background_spritesheet optional	:: FileName	Only loaded if `layout` or `background_layout` is defined. [...]
Only loaded if `layout` or `background_layout` is defined. [...]
background_mask_spritesheet optional	:: FileName	Only loaded if `layout` or `background_mask_layout` is defined. [...]
Only loaded if `layout` or `background_mask_layout` is defined. [...]
effect_map_spritesheet optional	:: FileName	Only loaded if `layout` or `effect_map_layout` is defined. [...]
Only loaded if `layout` or `effect_map_layout` is defined. [...]
lightmap_spritesheet optional	:: FileName	Only loaded if `layout` or `lightmap_layout` is defined. [...]
Only loaded if `layout` or `lightmap_layout` is defined. [...]
auxiliary_effect_mask_spritesheet optional	:: FileName	Only loaded if `layout` or `auxiliary_effect_mask_layout` is defined. [...]
Only loaded if `layout` or `auxiliary_effect_mask_layout` is defined. [...]
water_patch optional	:: Sprite
overlay_layer_group optional	:: TileRenderLayer
background_layer_group optional	:: TileRenderLayer
waving_effect_time_scale optional	:: float
overlay_layer_offset optional	:: int8
masked_overlay_layer_offset optional	:: int8
background_layer_offset optional	:: int8
masked_background_layer_offset optional	:: int8
draw_background_layer_under_tiles optional	:: boolean
background_layer_occludes_light optional	:: boolean	If drawing under water which is supposed to yield water mask, set this to `false` to not mess up the water mask.
If drawing under water which is supposed to yield water mask, set this to `false` to not mess up the water mask.
apply_effect_color_to_overlay optional	:: boolean
apply_waving_effect_on_masks optional	:: boolean
apply_waving_effect_on_background_mask optional	:: boolean
draw_simple_outer_corner_over_diagonal optional	:: boolean
offset_background_layer_by_tile_layer optional	:: boolean
inner_corner_weights optional	:: array[float]
outer_corner_weights optional	:: array[float]
side_weights optional	:: array[float]
side_variations_in_group optional	:: uint8
double_side_weights optional	:: array[float]
double_side_variations_in_group optional	:: uint8
u_transition_weights optional	:: array[float]

Properties

layout :: TileTransitionSpritesheetLayout optional

spritesheet :: FileName optional

Default spritesheet for all TileSpriteLayouts.

overlay_enabled :: boolean optional

Default: true

mask_enabled :: boolean optional

Default: true

background_enabled :: boolean optional

Default: true

background_mask_enabled :: boolean optional

Default: true

effect_map_enabled :: boolean optional

Default: true

lightmap_enabled :: boolean optional

Default: true

auxiliary_effect_mask_enabled :: boolean optional

Default: true

overlay_layout :: TileTransitionVariantLayout optional

Overrides the overlay definition inside layout.

mask_layout :: TileTransitionVariantLayout optional

Overrides the mask definition inside layout.

background_layout :: TileTransitionVariantLayout optional

Overrides the background definition inside layout.

background_mask_layout :: TileTransitionVariantLayout optional

Overrides the background_mask definition inside layout.

effect_map_layout :: TileTransitionVariantLayout optional

Overrides the effect_map definition inside layout.

lightmap_layout :: TileTransitionVariantLayout optional

Overrides the lightmap definition inside layout.