Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Module:GetParameters/doc

From the Star Citizen Wiki, the fidelity™ encyclopedia

This is the documentation page for Module:GetParameters

Function list
L 9 — p.getParameters
L 29 — p.getBoolean
L 48 — p.defined

Usage

getParameters

Takes 2 required arguments, frame_args and arg_list. Parses a frame's arguments, returning either the provided named arguments in arg_list if found or the positional parameters instead if not. This is designed to work around the stripping of values that takes place for defined parameters which could be important.

As an example, the calls getParameters({"a", "b", "c"}, {"x", "y"}) and getParameters({x="a", y="b", z="c"}, {"x", "y"}) would both give back {x="a", y="b"}.

getBoolean

Takes 1 required argument boolean_str. Turns the input into a true/false boolean value based on the input. Will error if given anything other than a string or boolean value.

defined

To be invoked from inside a template instead of a module. Determines if a certain parameter is defined in the parent frame's arguments.

See also

Heya! We only use cookie to make the site function and save your preferences, nothing else :)