Struct LuaRendering 

pub struct LuaRendering;

Allows rendering of geometric shapes, text and sprites in the game world through the global object named rendering. Each render object is identified by an id that is universally unique for the lifetime of a whole game.

If an entity target of an object (except its orientation_target) is destroyed or changes surface, then the object is also destroyed.

Implementations

impl LuaRendering

pub fn object_name(&self) -> &'static 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 clear(&self, mod_name: Option<&'static str>)

Destroys all render objects.

pub fn draw_animation( &self, params: LuaRenderingDrawAnimationParams, ) -> LuaRenderObject

Create an animation.

pub fn draw_arc(&self, params: LuaRenderingDrawArcParams) -> LuaRenderObject

Create an arc.

pub fn draw_circle( &self, params: LuaRenderingDrawCircleParams, ) -> LuaRenderObject

Create a circle.

pub fn draw_light(&self, params: LuaRenderingDrawLightParams) -> LuaRenderObject

Create a gradient light which is not occluded by any sprites. It is rendered at lower resolution, so it takes less GPU power. The same technique is used for lights drawn by LightDefinition.

The base game uses the utility sprites light_medium and light_small for lights.

pub fn draw_line(&self, params: LuaRenderingDrawLineParams) -> LuaRenderObject

Create a line.

pub fn draw_polygon( &self, params: LuaRenderingDrawPolygonParams, ) -> LuaRenderObject

Create a triangle mesh defined by a triangle strip.

pub fn draw_rectangle( &self, params: LuaRenderingDrawRectangleParams, ) -> LuaRenderObject

Create a rectangle.

pub fn draw_sprite( &self, params: LuaRenderingDrawSpriteParams, ) -> LuaRenderObject

Create a sprite.

pub fn draw_text(&self, params: LuaRenderingDrawTextParams) -> LuaRenderObject

Create a text.

Not all fonts support scaling.

pub fn get_all_objects( &self, mod_name: Option<&'static str>, ) -> Vec<LuaRenderObject>

Gets an array of all valid objects.

pub fn get_object_by_id(&self, object_id: u64) -> Option<LuaRenderObject>

Gives LuaRenderObject for given object ID. May return nil if object does not exist or is invalid.

Trait Implementations

impl Clone for LuaRendering

fn clone(&self) -> LuaRendering

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaRendering

impl Debug for LuaRendering

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

Formats the value using the given formatter.

impl Default for LuaRendering

fn default() -> LuaRendering

Returns the “default value” for a type.

impl Eq for LuaRendering

impl From<LuaRendering> for LuaAny

fn from(_: LuaRendering) -> Self

Converts to this type from the input type.

impl LuaObject for LuaRendering

impl PartialEq for LuaRendering

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaRendering