Struct LuaApi 

pub struct LuaApi { /* private fields */ }

Description of the Lua scripting API of a game.

Implementations

impl LuaApi

pub fn owners(&self) -> &HashMap<String, HashMap<String, LuaFunction>>

Functions by owner, then by name. The owner is the part before : or . in a call (cm, common, FACTION_SCRIPT_INTERFACE, …), and the empty string for global functions.

pub fn events(&self) -> &HashMap<String, HashMap<String, LuaAccessor>>

Context accessors of each event, by event name, then by accessor name.

pub fn script_definitions(&self) -> &LuaDefinitions

Members and custom events defined by the vanilla scripts.

impl LuaApi

pub fn from_assembly_kit(docs_path: &Path) -> Result<Self>

This function builds the API description from the scripting docs of an Assembly Kit.

Arguments

• docs_path - Path of the scripting docs. See ASSEMBLY_KIT_SCRIPT_DOCS_PATH.

Returns

The API described by the docs.

Errors

Returns RLibError::AssemblyKitNotFound if the docs folder doesn’t exist, or an IO error if a page can’t be read.

pub fn add_vanilla_scripts(&mut self, dependencies: &Dependencies)

This function completes the API with the vanilla scripts from the dependencies cache.

Events from script/events.lua missing from the docs are added without accessors, and what the other vanilla scripts define is added to LuaApi::script_definitions.

Arguments

• dependencies - Dependencies cache with the vanilla files loaded.

pub fn hover_html(&self, target: &LuaHoverTarget) -> Option<String>

This function returns the docs of something in a script, formatted for a tooltip.

Arguments

• target - What to return the docs of.

Returns

The docs as Qt rich text, or None if the target is not documented.

pub fn function(&self, owner: &str, name: &str) -> Option<&LuaFunction>

This function returns a documented function.

Arguments

• owner - Owner of the function. Empty for global functions.
• name - Name of the function.

Returns

The function, if it’s documented.

Trait Implementations

impl Clone for LuaApi

fn clone(&self) -> LuaApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaApi

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

Formats the value using the given formatter.

impl Default for LuaApi

fn default() -> LuaApi

Returns the “default value” for a type.

impl PartialEq for LuaApi

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaApi