Struct LuaRenderingDrawLineParams 

pub struct LuaRenderingDrawLineParams {

    pub blink_interval: u16,
    pub color: Color,
    pub dash_length: f64,
    pub dash_offset: f64,
    pub draw_on_ground: bool,
    pub forces: ForceSet,
    pub from: ScriptRenderTarget,
    pub gap_length: f64,
    pub only_in_alt_mode: bool,
    pub players: Vec<PlayerIdentification>,
    pub render_mode: ScriptRenderMode,
    pub surface: SurfaceIdentification,
    pub time_to_live: u32,
    pub to: ScriptRenderTarget,
    pub visible: bool,
    pub width: f32,
}

Create a line.

Fields

blink_interval: u16

In ticks. Defaults to 0 (no blinking). Game alerts use 30.

color: Color

dash_length: f64

Length of the dashes that this line has. Used only if gap_length > 0. Default is 0.

dash_offset: f64

Starting offset to apply to dashes. Cannot be greater than dash_length + gap_length. Default is 0.

draw_on_ground: bool

If this should be drawn below sprites and entities. Defaults to false.

forces: ForceSet

The forces that this object is rendered to. Passing nil or an empty table will render it to all forces.

from: ScriptRenderTarget

gap_length: f64

Length of the gaps that this line has, in tiles. Default is 0.

only_in_alt_mode: bool

If this should only be rendered in alt mode. Defaults to false.

players: Vec<PlayerIdentification>

The players that this object is rendered to. Passing nil or an empty table will render it to all players.

render_mode: ScriptRenderMode

Mode which this object should render in. Defaults to “game”.

surface: SurfaceIdentification

time_to_live: u32

In ticks. Defaults to living forever.

to: ScriptRenderTarget

visible: bool

If this is rendered to anyone at all. Defaults to true.

width: f32

In pixels (32 per tile).

Trait Implementations

impl Clone for LuaRenderingDrawLineParams

fn clone(&self) -> LuaRenderingDrawLineParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaRenderingDrawLineParams

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

Formats the value using the given formatter.

impl Default for LuaRenderingDrawLineParams

fn default() -> LuaRenderingDrawLineParams

Returns the “default value” for a type.