Skip to main content

LuaRecordBuildBlueprintParams

Struct LuaRecordBuildBlueprintParams 

Source
pub struct LuaRecordBuildBlueprintParams {
    pub build_mode: String,
    pub by_player: LuaAny,
    pub direction: String,
    pub force: LuaAny,
    pub position: MapPosition,
    pub raise_built: bool,
    pub skip_fog_of_war: bool,
    pub surface: LuaAny,
}
Expand description

Build this blueprint at the given location.

Built entities can be come invalid between the building of the blueprint and the function returning if by_player or raise_built is used and one of those events invalidates the entity.

Fields§

§build_mode: String

If normal, blueprint will not be built if any one thing can’t be built. If forced, anything that can be built is built and obstructing nature entities will be deconstructed. If superforced, all obstructions will be deconstructed and the blueprint will be built.

§by_player: LuaAny

The player to use if any. If provided defines.events.on_built_entity will be fired for new entities and defines.events.on_blueprint_settings_pasted will be fired for existing entities that are updated.

§direction: String

The direction to use when building

§force: LuaAny

Force to use for the building

§position: MapPosition

The position to build at

§raise_built: bool

If true; defines.events.script_raised_built will be fired for new entities and defines.events.on_blueprint_settings_pasted will be fired for existing entities that are updated. Note: this is ignored if by_player is provided.

§skip_fog_of_war: bool

If chunks covered by fog-of-war are skipped.

§surface: LuaAny

Surface to build on

Trait Implementations§

Source§

impl Clone for LuaRecordBuildBlueprintParams

Source§

fn clone(&self) -> LuaRecordBuildBlueprintParams

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 Debug for LuaRecordBuildBlueprintParams

Source§

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

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

impl Default for LuaRecordBuildBlueprintParams

Source§

fn default() -> LuaRecordBuildBlueprintParams

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

Auto Trait Implementations§

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.