Module content.gui.main.script_param_util🔗
global record ScriptParamUtil
record ParamForUi
uiType: ScriptParamType iconStyle: IconStyle name: string values: {string} numbers: {number} tooltips: {string} defaultIndex: integer hideLabel: boolean allowCoalesce: boolean makeCompactButtonFn: function(number): TreeNodeId formatValueFn: function(number): string stepValueFn: function(number, integer, boolean): number endbuildScriptParamCompSimple: function(CompSimpleParam): TreeNodeId buildScriptParamComp: function(ScriptParam, integer, function(integer), boolean, boolean, function(boolean), boolean): TreeNodeId searchAndBuildScriptParamComp: function(string, function(string) : number, function(string, number), boolean, function(boolean), {string}, boolean): MenuIconReactUtil.HintWidgetParam.Data, TreeNodeId wrap: function(string, boolean, TreeNodeId, boolean, function(boolean), string): TreeNodeId getScriptParam: function(string, {string}): ScriptParam clampScriptParamToDiscreteValue: function(number, ScriptParam): number clampScriptParamValueIndex: function(number, ScriptParam): integer getScriptParamDefaultValue: function({number}, integer): number getScriptParamDefaultValueIndex: function({number}, integer): integer getScriptParamLabel: function(string, number, {string}): string getScriptParamLabelUnfiltered: function(string, number): string endrecord CompSimpleParam
scriptParam: ParamForUi currentValue: number onValueChange: function(number) toggleButtonsFlowLayout: boolean vertical: boolean compact: boolean addSpacer: boolean disableGamepadNavigation: boolean onHover: function(boolean) gameCtx: GameContext updateCurrentValue: boolean end
Category: globals🔗
ScriptParamUtil🔗
global record ScriptParamUtil
record ParamForUi
uiType: ScriptParamType iconStyle: IconStyle name: string values: {string} numbers: {number} tooltips: {string} defaultIndex: integer hideLabel: boolean allowCoalesce: boolean makeCompactButtonFn: function(number): TreeNodeId formatValueFn: function(number): string stepValueFn: function(number, integer, boolean): number endbuildScriptParamCompSimple: function(CompSimpleParam): TreeNodeId buildScriptParamComp: function(ScriptParam, integer, function(integer), boolean, boolean, function(boolean), boolean): TreeNodeId searchAndBuildScriptParamComp: function(string, function(string) : number, function(string, number), boolean, function(boolean), {string}, boolean): MenuIconReactUtil.HintWidgetParam.Data, TreeNodeId wrap: function(string, boolean, TreeNodeId, boolean, function(boolean), string): TreeNodeId getScriptParam: function(string, {string}): ScriptParam clampScriptParamToDiscreteValue: function(number, ScriptParam): number clampScriptParamValueIndex: function(number, ScriptParam): integer getScriptParamDefaultValue: function({number}, integer): number getScriptParamDefaultValueIndex: function({number}, integer): integer getScriptParamLabel: function(string, number, {string}): string getScriptParamLabelUnfiltered: function(string, number): string endrecord CompSimpleParam
scriptParam: ParamForUi currentValue: number onValueChange: function(number) toggleButtonsFlowLayout: boolean vertical: boolean compact: boolean addSpacer: boolean disableGamepadNavigation: boolean onHover: function(boolean) gameCtx: GameContext updateCurrentValue: boolean end
ScriptParamUtil.ParamForUi🔗
record ScriptParamUtil.ParamForUi
uiType: ScriptParamType iconStyle: IconStyle name: string values: {string} numbers: {number} tooltips: {string} defaultIndex: integer hideLabel: boolean allowCoalesce: boolean makeCompactButtonFn: function(number): TreeNodeId formatValueFn: function(number): string stepValueFn: function(number, integer, boolean): number end
ScriptParamUtil.ParamForUi.IconStyle🔗
ScriptParamUtil.ParamForUi.IconStyle."Colored"🔗
ScriptParamUtil.ParamForUi.IconStyle."Default"🔗
ScriptParamUtil.ParamForUi.uiType🔗
ScriptParamUtil.ParamForUi.uiType: ScriptParamType
ScriptParamUtil.ParamForUi.iconStyle🔗
ScriptParamUtil.ParamForUi.iconStyle: IconStyle
ScriptParamUtil.ParamForUi.name🔗
ScriptParamUtil.ParamForUi.name: string
ScriptParamUtil.ParamForUi.values🔗
ScriptParamUtil.ParamForUi.values: {string}
ScriptParamUtil.ParamForUi.numbers🔗
ScriptParamUtil.ParamForUi.numbers: {number}
ScriptParamUtil.ParamForUi.tooltips🔗
ScriptParamUtil.ParamForUi.tooltips: {string}
ScriptParamUtil.ParamForUi.defaultIndex🔗
ScriptParamUtil.ParamForUi.defaultIndex: integer
ScriptParamUtil.ParamForUi.hideLabel🔗
ScriptParamUtil.ParamForUi.hideLabel: boolean
ScriptParamUtil.ParamForUi.allowCoalesce🔗
ScriptParamUtil.ParamForUi.allowCoalesce: boolean
ScriptParamUtil.ParamForUi.makeCompactButtonFn🔗
function ScriptParamUtil.ParamForUi.makeCompactButtonFn(number): TreeNodeIdParameters
number
TreeNodeId
ScriptParamUtil.ParamForUi.formatValueFn🔗
function ScriptParamUtil.ParamForUi.formatValueFn(number): stringParameters
number
string
ScriptParamUtil.ParamForUi.stepValueFn🔗
function ScriptParamUtil.ParamForUi.stepValueFn(number, integer, boolean): numberParameters
numberintegerboolean
number
ScriptParamUtil.CompSimpleParam🔗
record ScriptParamUtil.CompSimpleParam
scriptParam: ParamForUi currentValue: number onValueChange: function(number) toggleButtonsFlowLayout: boolean vertical: boolean compact: boolean addSpacer: boolean disableGamepadNavigation: boolean onHover: function(boolean) gameCtx: GameContext updateCurrentValue: boolean end
ScriptParamUtil.CompSimpleParam.scriptParam🔗
ScriptParamUtil.CompSimpleParam.scriptParam: ParamForUi
ScriptParamUtil.CompSimpleParam.currentValue🔗
ScriptParamUtil.CompSimpleParam.currentValue: number
ScriptParamUtil.CompSimpleParam.onValueChange🔗
function ScriptParamUtil.CompSimpleParam.onValueChange(number)Parameters
number
ScriptParamUtil.CompSimpleParam.toggleButtonsFlowLayout🔗
ScriptParamUtil.CompSimpleParam.toggleButtonsFlowLayout: boolean
ScriptParamUtil.CompSimpleParam.vertical🔗
ScriptParamUtil.CompSimpleParam.vertical: boolean
ScriptParamUtil.CompSimpleParam.compact🔗
ScriptParamUtil.CompSimpleParam.compact: boolean
ScriptParamUtil.CompSimpleParam.addSpacer🔗
ScriptParamUtil.CompSimpleParam.addSpacer: boolean
ScriptParamUtil.CompSimpleParam.disableGamepadNavigation🔗
ScriptParamUtil.CompSimpleParam.disableGamepadNavigation: boolean
ScriptParamUtil.CompSimpleParam.onHover🔗
function ScriptParamUtil.CompSimpleParam.onHover(boolean)Parameters
boolean
ScriptParamUtil.CompSimpleParam.gameCtx🔗
ScriptParamUtil.CompSimpleParam.gameCtx: GameContext
ScriptParamUtil.CompSimpleParam.updateCurrentValue🔗
ScriptParamUtil.CompSimpleParam.updateCurrentValue: boolean
ScriptParamUtil.buildScriptParamCompSimple🔗
function ScriptParamUtil.buildScriptParamCompSimple(CompSimpleParam): TreeNodeIdParameters
CompSimpleParam
TreeNodeId
ScriptParamUtil.buildScriptParamComp🔗
function ScriptParamUtil.buildScriptParamComp(ScriptParam, integer, function(integer), boolean, boolean, function(boolean), boolean): TreeNodeIdParameters
ScriptParamintegerfunction(integer)booleanbooleanfunction(boolean)boolean
TreeNodeId
ScriptParamUtil.searchAndBuildScriptParamComp🔗
function ScriptParamUtil.searchAndBuildScriptParamComp(string, function(string) : number, function(string, number), boolean, function(boolean), {string}, boolean): MenuIconReactUtil.HintWidgetParam.Data, TreeNodeIdParameters
stringfunction(string): numberfunction(string, number)booleanfunction(boolean){string}boolean
MenuIconReactUtil.HintWidgetParam.DataTreeNodeId
ScriptParamUtil.wrap🔗
function ScriptParamUtil.wrap(string, boolean, TreeNodeId, boolean, function(boolean), string): TreeNodeIdParameters
stringbooleanTreeNodeIdbooleanfunction(boolean)string
TreeNodeId
ScriptParamUtil.getScriptParam🔗
function ScriptParamUtil.getScriptParam(string, {string}): ScriptParamParameters
string{string}
ScriptParam
ScriptParamUtil.clampScriptParamToDiscreteValue🔗
function ScriptParamUtil.clampScriptParamToDiscreteValue(number, ScriptParam): numberParameters
numberScriptParam
number
ScriptParamUtil.clampScriptParamValueIndex🔗
function ScriptParamUtil.clampScriptParamValueIndex(number, ScriptParam): integerParameters
numberScriptParam
integer
ScriptParamUtil.getScriptParamDefaultValue🔗
function ScriptParamUtil.getScriptParamDefaultValue({number}, integer): numberParameters
{number}integer
number
ScriptParamUtil.getScriptParamDefaultValueIndex🔗
function ScriptParamUtil.getScriptParamDefaultValueIndex({number}, integer): integerParameters
{number}integer
integer
ScriptParamUtil.getScriptParamLabel🔗
function ScriptParamUtil.getScriptParamLabel(string, number, {string}): stringParameters
stringnumber{string}
string
ScriptParamUtil.getScriptParamLabelUnfiltered🔗
function ScriptParamUtil.getScriptParamLabelUnfiltered(string, number): stringParameters
stringnumber
string