Skip to main content

Tile

Struct Tile 

Source
pub struct Tile {
Show 30 fields pub name: &'static str, pub layer: i64, pub map_color: Color, pub collision_mask: LuaAny, pub variants: LuaAny, pub hidden: Option<bool>, pub order: Option<&'static str>, pub subgroup: Option<&'static str>, pub icon: Option<&'static str>, pub factoriopedia_description: Option<&'static str>, pub hidden_in_factoriopedia: Option<bool>, pub localised_description: Option<&'static str>, pub localised_name: Option<&'static str>, pub parameter: Option<bool>, pub factoriopedia_alternative: Option<&'static str>, pub allowed_neighbors: Option<&'static [&'static str]>, pub allows_being_covered: Option<bool>, pub ambient_sounds_group: Option<&'static str>, pub built_animation_frame: Option<i64>, pub can_be_part_of_blueprint: Option<bool>, pub check_collision_with_entities: Option<bool>, pub decorative_removal_probability: Option<f64>, pub default_cover_tile: Option<&'static str>, pub destroys_dropped_items: Option<bool>, pub effect: Option<&'static str>, pub effect_color: Option<Color>, pub effect_color_secondary: Option<Color>, pub effect_is_opaque: Option<bool>, pub fluid: Option<&'static str>, pub frozen_variant: Option<&'static str>,
}
Expand description

Minimal TilePrototype for data.extend.

A tile.

type = "tile" is injected by the Lua generator.

Fields§

§name: &'static str

Unique textual identification of the prototype. May only contain alphanumeric characters, dashes and underscores. May not exceed a length of 200 characters.

For a list of all names used in vanilla, see data.raw.

§layer: i64

Specifies transition drawing priority. This represents the positive offset from this tile’s layer_group. Internally, the final layer is computed as layer_group + layer (a uint16), wrapping back to "zero" after the "top" layer.

§map_color: Color

Prototype property map_color.

§collision_mask: LuaAny

Prototype property collision_mask.

§variants: LuaAny

Graphics for this tile.

§hidden: Option<bool>

Prototype property hidden.

§order: Option<&'static str>

Used to order prototypes in inventory, recipes and GUIs. May not exceed a length of 200 characters.

§subgroup: Option<&'static str>

The name of an ItemSubGroup.

§icon: Option<&'static str>

Path to the icon file. If this and icons is not set, the material_background in variants is used as the icon.

Only loaded if icons is not defined.

§factoriopedia_description: Option<&'static str>

Provides additional description used in factoriopedia.

§hidden_in_factoriopedia: Option<bool>

Prototype property hidden_in_factoriopedia.

§localised_description: Option<&'static str>

Overwrites the description set in the locale file. The description is usually shown in the tooltip of the prototype.

§localised_name: Option<&'static str>

Overwrites the name set in the locale file. Can be used to easily set a procedurally-generated name because the LocalisedString format allows to insert parameters into the name directly from the Lua script.

§parameter: Option<bool>

Whether the prototype is a special type which can be used to parametrize blueprints and doesn’t have other function.

§factoriopedia_alternative: Option<&'static str>

The ID type corresponding to the prototype that inherits from this.

For example, if this is an EntityPrototype, this property’s type is EntityID.

§allowed_neighbors: Option<&'static [&'static str]>

Array of tile names that are allowed next to this one.

§allows_being_covered: Option<bool>

Prototype property allows_being_covered.

§ambient_sounds_group: Option<&'static str>

Prototype property ambient_sounds_group.

§built_animation_frame: Option<i64>

When the build_animations frame reaches this point the tile is built.

Mandatory if build_animations is defined.

§can_be_part_of_blueprint: Option<bool>

Prototype property can_be_part_of_blueprint.

§check_collision_with_entities: Option<bool>

If set to true, the game will check for collisions with entities before building or mining the tile. If entities are in the way it is not possible to mine/build the tile.

§decorative_removal_probability: Option<f64>

Prototype property decorative_removal_probability.

§default_cover_tile: Option<&'static str>

Prototype property default_cover_tile.

§destroys_dropped_items: Option<bool>

If items dropped on this tile are destroyed.

§effect: Option<&'static str>

Prototype property effect.

§effect_color: Option<Color>

Prototype property effect_color.

§effect_color_secondary: Option<Color>

Used by the pollution shader.

§effect_is_opaque: Option<bool>

Prototype property effect_is_opaque.

§fluid: Option<&'static str>

Prototype property fluid.

§frozen_variant: Option<&'static str>

Prototype property frozen_variant.

Trait Implementations§

Source§

impl Clone for Tile

Source§

fn clone(&self) -> Tile

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Tile

Source§

impl Debug for Tile

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Tile

Source§

fn default() -> Tile

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Tile

Source§

fn eq(&self, other: &Tile) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Tile

Auto Trait Implementations§

§

impl Freeze for Tile

§

impl RefUnwindSafe for Tile

§

impl Send for Tile

§

impl Sync for Tile

§

impl Unpin for Tile

§

impl UnsafeUnpin for Tile

§

impl UnwindSafe for Tile

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.