Struct LuaModSettingPrototype 

pub struct LuaModSettingPrototype;

Prototype of a mod setting.

Implementations

impl LuaModSettingPrototype

pub fn custom_tooltip_fields(&self) -> Vec<CustomTooltipField>

Extra description items in the tooltip and Factoriopedia.

pub fn factoriopedia_description(&self) -> &str

Provides additional description used in factoriopedia.

pub fn group(&self) -> LuaGroup

Group of this prototype.

pub fn hidden(&self) -> bool

pub fn hidden_in_factoriopedia(&self) -> bool

pub fn localised_description(&self) -> &str

pub fn localised_name(&self) -> &str

pub fn name(&self) -> &str

Name of this prototype.

pub fn order(&self) -> &str

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.

pub fn parameter(&self) -> bool

pub fn subgroup(&self) -> LuaGroup

Subgroup of this prototype.

pub fn type(&self) -> &str

Type of this prototype.

pub fn allow_blank(&self) -> bool

Whether this string setting allows blank values. nil if not a string setting.

pub fn allowed_values(&self) -> LuaAny

The allowed values for this setting. nil if this setting doesn’t use the a fixed set of values.

pub fn auto_trim(&self) -> bool

Whether this string setting auto-trims values. nil if not a string setting

pub fn default_value(&self) -> LuaAny

The default value of this setting.

pub fn maximum_value(&self) -> LuaAny

The maximum value for this setting. nil if this setting type doesn’t support a maximum.

pub fn minimum_value(&self) -> LuaAny

The minimum value for this setting. nil if this setting type doesn’t support a minimum.

pub fn mod(&self) -> &str

The mod that owns this setting.

pub fn object_name(&self) -> &str

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

pub fn setting_type(&self) -> LuaModSettingPrototypeSettingType

pub fn valid(&self) -> bool

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

Trait Implementations

impl Clone for LuaModSettingPrototype

fn clone(&self) -> LuaModSettingPrototype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaModSettingPrototype

impl Debug for LuaModSettingPrototype

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

Formats the value using the given formatter.

impl Default for LuaModSettingPrototype

fn default() -> LuaModSettingPrototype

Returns the “default value” for a type.

impl Eq for LuaModSettingPrototype

impl From<LuaModSettingPrototype> for LuaAny

fn from(_: LuaModSettingPrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaModSettingPrototype

impl PartialEq for LuaModSettingPrototype

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaModSettingPrototype