Module:Arguments/doc

From the RuneScape Wiki, the wiki for all things RuneScape
Jump to navigation Jump to search

This is the documentation page for Module:Arguments

This is a documentation subpage for Module:Arguments.
It contains usage information, categories, and other content that is not part of the original module page.
Module:Arguments requires libraryUtil.
Module:Arguments is required by .
Function list
L 13 — tidyValDefault
L 26 — tidyValTrimOnly
L 34 — tidyValRemoveBlanksOnly
L 46 — tidyValNoChange
L 50 — matchesTitle
L 57 — arguments.getArgs
L 199 — mergeArgs
L 299 — translatenext
L 326 — inext

This module provides easy processing of arguments passed to Scribunto from #invoke. This module is a helper module to be used by other modules; it may not be designed to be invoked directly. See RuneScape:Lua/Helper modules for a full list and more information.

FunctionTypeUse
getArgstable, tableGet the argument tables. If we were passed a valid frame object, get the frame arguments (fargs) and the parent frame arguments (pargs), depending on the options set and on the parent frame's availability. If we weren't passed a valid frame object, we are being called from another Lua module or from the debug console, so assume that we were passed a table of args directly, and assign it to a new variable (luaArgs).