Struct Helpers 

pub struct Helpers { /* private fields */ }

Helper surface injected before every invocation.

The runtime always defines the upstream helper vect and the six constant objects Map, Hero, Gamemode, Color, Team, Button (see builtInJsFunctions in the OverPy reference src/globalVars.ts). The constant entries are Workshop catalog data that workshop-rs owns, so this crate ships them empty; populate them with Helpers::set_constant.

Implementations

impl Helpers

pub fn new() -> Self

Creates an empty helper set: only the builtin vect function and the six empty constant objects exist.

pub fn set_constant(&mut self, object: &str, key: &str, value: &str)

Adds one key -> value entry to the constant object object.

Matches the upstream ABI where each entry is an UPPER_SNAKE key mapped to a string carrying the object prefix, e.g. set_constant("Map", "KANEZAKA", "Map.KANEZAKA") makes Map.KANEZAKA === "Map.KANEZAKA" inside scripts.

pub fn entries(&self, object: &str) -> &[(String, String)]

Entries configured for object, in insertion order.

Trait Implementations

impl Clone for Helpers

fn clone(&self) -> Helpers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Helpers

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

Formats the value using the given formatter.

impl Default for Helpers

fn default() -> Helpers

Returns the “default value” for a type.

impl Eq for Helpers

impl PartialEq for Helpers

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Helpers