Struct LuaRenderingDrawSpriteParams 

pub struct LuaRenderingDrawSpriteParams {

    pub blink_interval: u16,
    pub forces: LuaAny,
    pub light_mode: ScriptSpriteLightMode,
    pub only_in_alt_mode: bool,
    pub orientation: LuaAny,
    pub orientation_target: LuaAny,
    pub oriented_offset: Vector,
    pub players: Vec<LuaAny>,
    pub render_layer: LuaAny,
    pub render_mode: ScriptRenderMode,
    pub sprite: SpritePath,
    pub surface: LuaAny,
    pub target: LuaAny,
    pub time_to_live: u32,
    pub tint: Color,
    pub use_target_orientation: bool,
    pub visible: bool,
    pub x_scale: f64,
    pub y_scale: f64,
}

Create a sprite.

Fields

blink_interval: u16

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

forces: LuaAny

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

light_mode: ScriptSpriteLightMode

Whether this object should be rendered as a sprite, light or both at once. Defaults to “occluder”.

only_in_alt_mode: bool

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

orientation: LuaAny

The orientation of the sprite. Default is 0.

orientation_target: LuaAny

If given, the sprite rotates so that it faces this target. Note that orientation is still applied to the sprite.

oriented_offset: Vector

Offsets the center of the sprite if orientation_target is given. This offset will rotate together with the sprite.

players: Vec<LuaAny>

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

render_layer: LuaAny

Render layer of the sprite. Defaults to "arrow".

render_mode: ScriptRenderMode

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

sprite: SpritePath

surface: LuaAny

target: LuaAny

Center of the sprite.

time_to_live: u32

In ticks. Defaults to living forever.

tint: Color

use_target_orientation: bool

Only used if orientation_target is a LuaEntity.

visible: bool

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

x_scale: f64

Horizontal scale of the sprite. Default is 1.

y_scale: f64

Vertical scale of the sprite. Default is 1.

Trait Implementations

impl Clone for LuaRenderingDrawSpriteParams

fn clone(&self) -> LuaRenderingDrawSpriteParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaRenderingDrawSpriteParams

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

Formats the value using the given formatter.

impl Default for LuaRenderingDrawSpriteParams

fn default() -> LuaRenderingDrawSpriteParams

Returns the “default value” for a type.