Prototype/TileEffect

From Official Factorio Wiki
Jump to navigation Jump to search

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/TileEffectDefinition.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.


Prototype definitions » Prototype/TileEffect


Used to define the parameters for the water shader.


Prototype/TileEffect — tile-effect
animation_scale::float or array of two float
animation_speed::float
dark_threshold::float or array of two float
foam_color::Color
foam_color_multiplier::float
name::string
reflection_threshold::float or array of two float
specular_lightness::Color
specular_threshold::float or array of two float
texture::Sprite
tick_scale::float
type::string
far_zoom::float (optional)
near_zoom::float (optional)

Mandatory properties

type

Type: string
Must be "tile-effect".

name

Type: string
Name of the tile-effect. Must be "water" since only one instances of this prototype can be defined.

specular_lightness

Type: Color

foam_color

Type: Color

foam_color_multiplier

Type: float

tick_scale

Type: float

animation_speed

Type: float

animation_scale

Type: float or array of two float

dark_threshold

Type: float or array of two float

reflection_threshold

Type: float or array of two float

specular_threshold

Type: float or array of two float

texture

Type: Sprite
Sprite size must be 512x512.

Optional properties

near_zoom

Type: float
Default: 2.0

far_zoom

Type: float
Default: 0.5