Struct LuaAISettings 

pub struct LuaAISettings;

Collection of settings for overriding default AI behavior.

Implementations

impl LuaAISettings

pub fn allow_destroy_when_commands_fail(&self) -> bool

If enabled, units that repeatedly fail to succeed at commands will be destroyed.

pub fn allow_try_return_to_spawner(&self) -> bool

If enabled, units that have nothing else to do will attempt to return to a spawner.

pub fn do_separation(&self) -> bool

If enabled, units will try to separate themselves from nearby friendly units.

pub fn join_attacks(&self) -> bool

If enabled, the unit will join attack groups.

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 path_resolution_modifier(&self) -> i8

Defines how coarse the pathfinder’s grid is, where smaller values mean a coarser grid. Defaults to 0, which equals a resolution of 1x1 tiles, centered on tile centers. Values range from -8 to 8 inclusive, where each integer increment doubles/halves the resolution. So, a resolution of -8 equals a grid of 256x256 tiles, and a resolution of 8 equals 1/256 of a tile.

pub fn size_in_group(&self) -> f32

The number of “slots” that the unit takes up in a unit group. Must be greater than 0.

If this value is changed after the unit has been added to a group, the exact behavior is undefined.

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 LuaAISettings

fn clone(&self) -> LuaAISettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaAISettings

impl Debug for LuaAISettings

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

Formats the value using the given formatter.

impl Default for LuaAISettings

fn default() -> LuaAISettings

Returns the “default value” for a type.

impl Eq for LuaAISettings

impl From<LuaAISettings> for LuaAny

fn from(_: LuaAISettings) -> Self

Converts to this type from the input type.

impl LuaObject for LuaAISettings

impl PartialEq for LuaAISettings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaAISettings