Module content.gui.main.gui_react_util🔗

[Expand All] [Collapse All]
global record GuiReactUtil
  
enum LabelFontColor
    "Default"
    "Error"
    "Inferior"
    "Negative"
    "Normal"
    "Poor"
    "Positive"
    "Warning"
end
  
enum LabelMode
    "Default"
    "EntityWindow"
    "EntityWindowPostfix"
    "HudIconLayer"
    "HudIconMain"
end
  
enum MouseCursor
    "AddStopInvalid"
    "AddStopValid"
    "Bulldoze"
    "Camera"
    "CompanyMechanics"
    "Config"
    "Construction"
    "ConstructionTool"
    "Cut"
    "Default"
    "Grab"
    "Invalid"
    "Link"
    "Lock"
    "NoSnap"
    "None"
    "PlaceAsset"
    "Prospection"
    "Rail"
    "Raise"
    "Resize"
    "Snap"
    "StreetStraight"
    "Tangent"
    "TerrainModify"
    "TerrainPaint"
    "Text"
    "Turn"
    "TurnRaise"
    "Unlock"
    "Upgrade"
    "Wait"
end
  getMouseCursorInteger: function(GuiReactUtil.MouseCursor): integer
  
enum ForegroundContrast
    "Dark"
    "Light"
end
  
enum ShippingState
    "IndustryInput"
    "IndustryOutput"
    "Vehicle"
    "WaitingPassenger"
    "Warehouse"
end
  
record RichLabel
    text: string
    iconPath: string
    useEmoteWithSatisfaction: EmoteIconParam.Satisfaction
    textAfterIcon: string
end
  
record IconLabelIndicatorParams
    iconPath: string | {string}
    useEmoteWithSatisfaction: EmoteIconParam.Satisfaction
    label: string
    richLabel: RichLabel
    labelFontColor: LabelFontColor
    labelMode: LabelMode
    indicatorIconPath: string
    tooltip: string
    iconTooltip: string | {string}
    overlay: TreeNodeId
    indicator: TreeNodeId
    shippingState: ShippingState
end
  
record TextLabelIndicatorParams
    text: string
    label: string
    richLabel: RichLabel
    labelFontColor: LabelFontColor
    labelMode: LabelMode
    indicatorIconPath: string
    tooltip: string
    shippingState: ShippingState
end
  
record ContentLabelIndicatorParams
    content: TreeNodeId
    label: string
    richLabel: RichLabel
    labelFontColor: LabelFontColor
    labelMode: LabelMode
    labelExtraContent: TreeNodeId
    indicatorIconPath: string
    tooltip: string
    overlay: TreeNodeId
    indicator: TreeNodeId
    shippingState: ShippingState
end
  isHudLabelMode: function(LabelMode): boolean
  IconLabelIndicator: Recipe<IconLabelIndicatorParams>
  TextLabelIndicator: Recipe<TextLabelIndicatorParams>
  makeContentLabelIndictator: function(IconLabelIndicatorParams): TreeNodeId
  integer2TextLayout: function(integer, string): TreeNodeId
  
record FocusInputFieldParam<T>
    value: T
    onValueChange: function(T)
    onCancel: function()
    class: string
    maxLength: integer
end
  FocusNumberInputField: Recipe<FocusInputFieldParam<number>>
  FocusTextInputField: Recipe<FocusInputFieldParam<string>>
  group: function(TreeNodeId): TreeNodeId
  textColorForColor: function(Vec4f): Vec4f
  foregroundColorClassForColor: function(Vec4f): GuiReactUtil.ForegroundContrast
  stylingHoverClassForColor: function(Vec4f): GuiReactUtil.ForegroundContrast
  makeHorizontalSpacer: function(): TreeNodeId
  makeVerticalSpacer: function(): TreeNodeId
  makeHorizontalBox: function({TreeNodeId}): TreeNodeId
  makeVerticalBox: function({TreeNodeId}): TreeNodeId
  transformSetUnlessEqual: function<T>(state : ReactStateT<T>, newValue : T, equals : function(T, T) : boolean)
  
record FocusTraversalScopeParam
    horizontal: boolean
    vertical: boolean
    allowBubbleUp: boolean
    layout: TreeNodeId
end
  FocusTraversalScope: Recipe<FocusTraversalScopeParam>
  
record InputActionComponentParam
    iaOrder: {string}
    iaForwards: {string : React.IaForward}
    iaHandlers: {string : React.IaHandler}
    layout: TreeNodeId
end
  InputActionComponent: Recipe<InputActionComponentParam>
  
record EmoteIconParam
    
enum Satisfaction
      "Aloof"
      "Happy"
      "Sad"
end
    satisfaction: Satisfaction
    tooltip: string
    forceFocusable: boolean
end
  EmoteIcon: Recipe<EmoteIconParam>
  
record PluginScopeConfig
    firstRef: ReactRefWrap
    lastRef: ReactRefWrap
    insertHardcoded: {integer : {TreeNodeId}}
end
  usePlugins: function<ParamType>(ExtensionPoint<ParamType>, PluginScopeConfig, ParamType): {TreeNodeId}



end

Category: globals🔗

GuiReactUtil🔗

[Expand All] [Collapse All]
global record GuiReactUtil
  
enum LabelFontColor
    "Default"
    "Error"
    "Inferior"
    "Negative"
    "Normal"
    "Poor"
    "Positive"
    "Warning"
end
  
enum LabelMode
    "Default"
    "EntityWindow"
    "EntityWindowPostfix"
    "HudIconLayer"
    "HudIconMain"
end
  
enum MouseCursor
    "AddStopInvalid"
    "AddStopValid"
    "Bulldoze"
    "Camera"
    "CompanyMechanics"
    "Config"
    "Construction"
    "ConstructionTool"
    "Cut"
    "Default"
    "Grab"
    "Invalid"
    "Link"
    "Lock"
    "NoSnap"
    "None"
    "PlaceAsset"
    "Prospection"
    "Rail"
    "Raise"
    "Resize"
    "Snap"
    "StreetStraight"
    "Tangent"
    "TerrainModify"
    "TerrainPaint"
    "Text"
    "Turn"
    "TurnRaise"
    "Unlock"
    "Upgrade"
    "Wait"
end
  getMouseCursorInteger: function(GuiReactUtil.MouseCursor): integer
  
enum ForegroundContrast
    "Dark"
    "Light"
end
  
enum ShippingState
    "IndustryInput"
    "IndustryOutput"
    "Vehicle"
    "WaitingPassenger"
    "Warehouse"
end
  
record RichLabel
    text: string
    iconPath: string
    useEmoteWithSatisfaction: EmoteIconParam.Satisfaction
    textAfterIcon: string
end
  
record IconLabelIndicatorParams
    iconPath: string | {string}
    useEmoteWithSatisfaction: EmoteIconParam.Satisfaction
    label: string
    richLabel: RichLabel
    labelFontColor: LabelFontColor
    labelMode: LabelMode
    indicatorIconPath: string
    tooltip: string
    iconTooltip: string | {string}
    overlay: TreeNodeId
    indicator: TreeNodeId
    shippingState: ShippingState
end
  
record TextLabelIndicatorParams
    text: string
    label: string
    richLabel: RichLabel
    labelFontColor: LabelFontColor
    labelMode: LabelMode
    indicatorIconPath: string
    tooltip: string
    shippingState: ShippingState
end
  
record ContentLabelIndicatorParams
    content: TreeNodeId
    label: string
    richLabel: RichLabel
    labelFontColor: LabelFontColor
    labelMode: LabelMode
    labelExtraContent: TreeNodeId
    indicatorIconPath: string
    tooltip: string
    overlay: TreeNodeId
    indicator: TreeNodeId
    shippingState: ShippingState
end
  isHudLabelMode: function(LabelMode): boolean
  IconLabelIndicator: Recipe<IconLabelIndicatorParams>
  TextLabelIndicator: Recipe<TextLabelIndicatorParams>
  makeContentLabelIndictator: function(IconLabelIndicatorParams): TreeNodeId
  integer2TextLayout: function(integer, string): TreeNodeId
  
record FocusInputFieldParam<T>
    value: T
    onValueChange: function(T)
    onCancel: function()
    class: string
    maxLength: integer
end
  FocusNumberInputField: Recipe<FocusInputFieldParam<number>>
  FocusTextInputField: Recipe<FocusInputFieldParam<string>>
  group: function(TreeNodeId): TreeNodeId
  textColorForColor: function(Vec4f): Vec4f
  foregroundColorClassForColor: function(Vec4f): GuiReactUtil.ForegroundContrast
  stylingHoverClassForColor: function(Vec4f): GuiReactUtil.ForegroundContrast
  makeHorizontalSpacer: function(): TreeNodeId
  makeVerticalSpacer: function(): TreeNodeId
  makeHorizontalBox: function({TreeNodeId}): TreeNodeId
  makeVerticalBox: function({TreeNodeId}): TreeNodeId
  transformSetUnlessEqual: function<T>(state : ReactStateT<T>, newValue : T, equals : function(T, T) : boolean)
  
record FocusTraversalScopeParam
    horizontal: boolean
    vertical: boolean
    allowBubbleUp: boolean
    layout: TreeNodeId
end
  FocusTraversalScope: Recipe<FocusTraversalScopeParam>
  
record InputActionComponentParam
    iaOrder: {string}
    iaForwards: {string : React.IaForward}
    iaHandlers: {string : React.IaHandler}
    layout: TreeNodeId
end
  InputActionComponent: Recipe<InputActionComponentParam>
  
record EmoteIconParam
    
enum Satisfaction
      "Aloof"
      "Happy"
      "Sad"
end
    satisfaction: Satisfaction
    tooltip: string
    forceFocusable: boolean
end
  EmoteIcon: Recipe<EmoteIconParam>
  
record PluginScopeConfig
    firstRef: ReactRefWrap
    lastRef: ReactRefWrap
    insertHardcoded: {integer : {TreeNodeId}}
end
  usePlugins: function<ParamType>(ExtensionPoint<ParamType>, PluginScopeConfig, ParamType): {TreeNodeId}



end

GuiReactUtil.LabelFontColor🔗

enum GuiReactUtil.LabelFontColor
  "Default"
  "Error"
  "Inferior"
  "Negative"
  "Normal"
  "Poor"
  "Positive"
  "Warning"
end

GuiReactUtil.LabelFontColor."Default"🔗

GuiReactUtil.LabelFontColor."Error"🔗

GuiReactUtil.LabelFontColor."Inferior"🔗

GuiReactUtil.LabelFontColor."Negative"🔗

GuiReactUtil.LabelFontColor."Normal"🔗

GuiReactUtil.LabelFontColor."Poor"🔗

GuiReactUtil.LabelFontColor."Positive"🔗

GuiReactUtil.LabelFontColor."Warning"🔗

GuiReactUtil.LabelMode🔗

enum GuiReactUtil.LabelMode
  "Default"
  "EntityWindow"
  "EntityWindowPostfix"
  "HudIconLayer"
  "HudIconMain"
end

GuiReactUtil.LabelMode."Default"🔗

GuiReactUtil.LabelMode."EntityWindow"🔗

GuiReactUtil.LabelMode."EntityWindowPostfix"🔗

GuiReactUtil.LabelMode."HudIconLayer"🔗

GuiReactUtil.LabelMode."HudIconMain"🔗

GuiReactUtil.MouseCursor🔗

enum GuiReactUtil.MouseCursor
  "AddStopInvalid"
  "AddStopValid"
  "Bulldoze"
  "Camera"
  "CompanyMechanics"
  "Config"
  "Construction"
  "ConstructionTool"
  "Cut"
  "Default"
  "Grab"
  "Invalid"
  "Link"
  "Lock"
  "NoSnap"
  "None"
  "PlaceAsset"
  "Prospection"
  "Rail"
  "Raise"
  "Resize"
  "Snap"
  "StreetStraight"
  "Tangent"
  "TerrainModify"
  "TerrainPaint"
  "Text"
  "Turn"
  "TurnRaise"
  "Unlock"
  "Upgrade"
  "Wait"
end

GuiReactUtil.MouseCursor."AddStopInvalid"🔗

GuiReactUtil.MouseCursor."AddStopValid"🔗

GuiReactUtil.MouseCursor."Bulldoze"🔗

GuiReactUtil.MouseCursor."Camera"🔗

GuiReactUtil.MouseCursor."CompanyMechanics"🔗

GuiReactUtil.MouseCursor."Config"🔗

GuiReactUtil.MouseCursor."Construction"🔗

GuiReactUtil.MouseCursor."ConstructionTool"🔗

GuiReactUtil.MouseCursor."Cut"🔗

GuiReactUtil.MouseCursor."Default"🔗

GuiReactUtil.MouseCursor."Grab"🔗

GuiReactUtil.MouseCursor."Invalid"🔗

GuiReactUtil.MouseCursor."Link"🔗

GuiReactUtil.MouseCursor."Lock"🔗

GuiReactUtil.MouseCursor."NoSnap"🔗

GuiReactUtil.MouseCursor."None"🔗

GuiReactUtil.MouseCursor."PlaceAsset"🔗

GuiReactUtil.MouseCursor."Prospection"🔗

GuiReactUtil.MouseCursor."Rail"🔗

GuiReactUtil.MouseCursor."Raise"🔗

GuiReactUtil.MouseCursor."Resize"🔗

GuiReactUtil.MouseCursor."Snap"🔗

GuiReactUtil.MouseCursor."StreetStraight"🔗

GuiReactUtil.MouseCursor."Tangent"🔗

GuiReactUtil.MouseCursor."TerrainModify"🔗

GuiReactUtil.MouseCursor."TerrainPaint"🔗

GuiReactUtil.MouseCursor."Text"🔗

GuiReactUtil.MouseCursor."Turn"🔗

GuiReactUtil.MouseCursor."TurnRaise"🔗

GuiReactUtil.MouseCursor."Unlock"🔗

GuiReactUtil.MouseCursor."Upgrade"🔗

GuiReactUtil.MouseCursor."Wait"🔗

GuiReactUtil.getMouseCursorInteger🔗

function GuiReactUtil.getMouseCursorInteger(GuiReactUtil.MouseCursor): integer

Parameters

• GuiReactUtil.MouseCursor

Returns

1. integer

GuiReactUtil.ForegroundContrast🔗

enum GuiReactUtil.ForegroundContrast
  "Dark"
  "Light"
end

GuiReactUtil.ForegroundContrast."Dark"🔗

GuiReactUtil.ForegroundContrast."Light"🔗

GuiReactUtil.ShippingState🔗

enum GuiReactUtil.ShippingState
  "IndustryInput"
  "IndustryOutput"
  "Vehicle"
  "WaitingPassenger"
  "Warehouse"
end

GuiReactUtil.ShippingState."IndustryInput"🔗

GuiReactUtil.ShippingState."IndustryOutput"🔗

GuiReactUtil.ShippingState."Vehicle"🔗

GuiReactUtil.ShippingState."WaitingPassenger"🔗

GuiReactUtil.ShippingState."Warehouse"🔗

GuiReactUtil.RichLabel🔗

record GuiReactUtil.RichLabel
  text: string
  iconPath: string
  useEmoteWithSatisfaction: EmoteIconParam.Satisfaction
  textAfterIcon: string
end

GuiReactUtil.RichLabel.text🔗

GuiReactUtil.RichLabel.text: string

GuiReactUtil.RichLabel.iconPath🔗

GuiReactUtil.RichLabel.iconPath: string

GuiReactUtil.RichLabel.useEmoteWithSatisfaction🔗

GuiReactUtil.RichLabel.useEmoteWithSatisfaction: EmoteIconParam.Satisfaction

GuiReactUtil.RichLabel.textAfterIcon🔗

GuiReactUtil.RichLabel.textAfterIcon: string

GuiReactUtil.IconLabelIndicatorParams🔗

record GuiReactUtil.IconLabelIndicatorParams
  iconPath: string | {string}
  useEmoteWithSatisfaction: EmoteIconParam.Satisfaction
  label: string
  richLabel: RichLabel
  labelFontColor: LabelFontColor
  labelMode: LabelMode
  indicatorIconPath: string
  tooltip: string
  iconTooltip: string | {string}
  overlay: TreeNodeId
  indicator: TreeNodeId
  shippingState: ShippingState
end

GuiReactUtil.IconLabelIndicatorParams.iconPath🔗

GuiReactUtil.IconLabelIndicatorParams.iconPath: string | {string}

GuiReactUtil.IconLabelIndicatorParams.useEmoteWithSatisfaction🔗

GuiReactUtil.IconLabelIndicatorParams.useEmoteWithSatisfaction: EmoteIconParam.Satisfaction

GuiReactUtil.IconLabelIndicatorParams.label🔗

GuiReactUtil.IconLabelIndicatorParams.label: string

GuiReactUtil.IconLabelIndicatorParams.richLabel🔗

GuiReactUtil.IconLabelIndicatorParams.richLabel: RichLabel

GuiReactUtil.IconLabelIndicatorParams.labelFontColor🔗

GuiReactUtil.IconLabelIndicatorParams.labelFontColor: LabelFontColor

GuiReactUtil.IconLabelIndicatorParams.labelMode🔗

GuiReactUtil.IconLabelIndicatorParams.labelMode: LabelMode

GuiReactUtil.IconLabelIndicatorParams.indicatorIconPath🔗

GuiReactUtil.IconLabelIndicatorParams.indicatorIconPath: string

GuiReactUtil.IconLabelIndicatorParams.tooltip🔗

GuiReactUtil.IconLabelIndicatorParams.tooltip: string

GuiReactUtil.IconLabelIndicatorParams.iconTooltip🔗

GuiReactUtil.IconLabelIndicatorParams.iconTooltip: string | {string}

GuiReactUtil.IconLabelIndicatorParams.overlay🔗

GuiReactUtil.IconLabelIndicatorParams.overlay: TreeNodeId

GuiReactUtil.IconLabelIndicatorParams.indicator🔗

GuiReactUtil.IconLabelIndicatorParams.indicator: TreeNodeId

GuiReactUtil.IconLabelIndicatorParams.shippingState🔗

GuiReactUtil.IconLabelIndicatorParams.shippingState: ShippingState

GuiReactUtil.TextLabelIndicatorParams🔗

record GuiReactUtil.TextLabelIndicatorParams
  text: string
  label: string
  richLabel: RichLabel
  labelFontColor: LabelFontColor
  labelMode: LabelMode
  indicatorIconPath: string
  tooltip: string
  shippingState: ShippingState
end

GuiReactUtil.TextLabelIndicatorParams.text🔗

GuiReactUtil.TextLabelIndicatorParams.text: string

GuiReactUtil.TextLabelIndicatorParams.label🔗

GuiReactUtil.TextLabelIndicatorParams.label: string

GuiReactUtil.TextLabelIndicatorParams.richLabel🔗

GuiReactUtil.TextLabelIndicatorParams.richLabel: RichLabel

GuiReactUtil.TextLabelIndicatorParams.labelFontColor🔗

GuiReactUtil.TextLabelIndicatorParams.labelFontColor: LabelFontColor

GuiReactUtil.TextLabelIndicatorParams.labelMode🔗

GuiReactUtil.TextLabelIndicatorParams.labelMode: LabelMode

GuiReactUtil.TextLabelIndicatorParams.indicatorIconPath🔗

GuiReactUtil.TextLabelIndicatorParams.indicatorIconPath: string

GuiReactUtil.TextLabelIndicatorParams.tooltip🔗

GuiReactUtil.TextLabelIndicatorParams.tooltip: string

GuiReactUtil.TextLabelIndicatorParams.shippingState🔗

GuiReactUtil.TextLabelIndicatorParams.shippingState: ShippingState

GuiReactUtil.ContentLabelIndicatorParams🔗

record GuiReactUtil.ContentLabelIndicatorParams
  content: TreeNodeId
  label: string
  richLabel: RichLabel
  labelFontColor: LabelFontColor
  labelMode: LabelMode
  labelExtraContent: TreeNodeId
  indicatorIconPath: string
  tooltip: string
  overlay: TreeNodeId
  indicator: TreeNodeId
  shippingState: ShippingState
end

GuiReactUtil.ContentLabelIndicatorParams.content🔗

GuiReactUtil.ContentLabelIndicatorParams.content: TreeNodeId

GuiReactUtil.ContentLabelIndicatorParams.label🔗

GuiReactUtil.ContentLabelIndicatorParams.label: string

GuiReactUtil.ContentLabelIndicatorParams.richLabel🔗

GuiReactUtil.ContentLabelIndicatorParams.richLabel: RichLabel

GuiReactUtil.ContentLabelIndicatorParams.labelFontColor🔗

GuiReactUtil.ContentLabelIndicatorParams.labelFontColor: LabelFontColor

GuiReactUtil.ContentLabelIndicatorParams.labelMode🔗

GuiReactUtil.ContentLabelIndicatorParams.labelMode: LabelMode

GuiReactUtil.ContentLabelIndicatorParams.labelExtraContent🔗

GuiReactUtil.ContentLabelIndicatorParams.labelExtraContent: TreeNodeId

GuiReactUtil.ContentLabelIndicatorParams.indicatorIconPath🔗

GuiReactUtil.ContentLabelIndicatorParams.indicatorIconPath: string

GuiReactUtil.ContentLabelIndicatorParams.tooltip🔗

GuiReactUtil.ContentLabelIndicatorParams.tooltip: string

GuiReactUtil.ContentLabelIndicatorParams.overlay🔗

GuiReactUtil.ContentLabelIndicatorParams.overlay: TreeNodeId

GuiReactUtil.ContentLabelIndicatorParams.indicator🔗

GuiReactUtil.ContentLabelIndicatorParams.indicator: TreeNodeId

GuiReactUtil.ContentLabelIndicatorParams.shippingState🔗

GuiReactUtil.ContentLabelIndicatorParams.shippingState: ShippingState

GuiReactUtil.isHudLabelMode🔗

function GuiReactUtil.isHudLabelMode(LabelMode): boolean

Parameters

• LabelMode

Returns

1. boolean

GuiReactUtil.IconLabelIndicator🔗

GuiReactUtil.IconLabelIndicator: Recipe<IconLabelIndicatorParams>

GuiReactUtil.TextLabelIndicator🔗

GuiReactUtil.TextLabelIndicator: Recipe<TextLabelIndicatorParams>

GuiReactUtil.makeContentLabelIndictator🔗

function GuiReactUtil.makeContentLabelIndictator(IconLabelIndicatorParams): TreeNodeId

Parameters

• IconLabelIndicatorParams

Returns

1. TreeNodeId

GuiReactUtil.integer2TextLayout🔗

function GuiReactUtil.integer2TextLayout(integer, string): TreeNodeId

Parameters

• integer
• string

Returns

1. TreeNodeId

GuiReactUtil.FocusInputFieldParam🔗

record GuiReactUtil.FocusInputFieldParam<T>
  value: T
  onValueChange: function(T)
  onCancel: function()
  class: string
  maxLength: integer
end

Type Parameters

• T

GuiReactUtil.FocusInputFieldParam.value🔗

GuiReactUtil.FocusInputFieldParam.value: T

GuiReactUtil.FocusInputFieldParam.onValueChange🔗

function GuiReactUtil.FocusInputFieldParam.onValueChange(T)

Parameters

• T

GuiReactUtil.FocusInputFieldParam.onCancel🔗

function GuiReactUtil.FocusInputFieldParam.onCancel()

GuiReactUtil.FocusInputFieldParam.class🔗

GuiReactUtil.FocusInputFieldParam.class: string

GuiReactUtil.FocusInputFieldParam.maxLength🔗

GuiReactUtil.FocusInputFieldParam.maxLength: integer

GuiReactUtil.FocusNumberInputField🔗

GuiReactUtil.FocusNumberInputField: Recipe<FocusInputFieldParam<number>>

GuiReactUtil.FocusTextInputField🔗

GuiReactUtil.FocusTextInputField: Recipe<FocusInputFieldParam<string>>

GuiReactUtil.group🔗

function GuiReactUtil.group(TreeNodeId): TreeNodeId

Parameters

• TreeNodeId

Returns

1. TreeNodeId

GuiReactUtil.textColorForColor🔗

function GuiReactUtil.textColorForColor(Vec4f): Vec4f

Parameters

• Vec4f

Returns

1. Vec4f

GuiReactUtil.foregroundColorClassForColor🔗

function GuiReactUtil.foregroundColorClassForColor(Vec4f): GuiReactUtil.ForegroundContrast

Parameters

• Vec4f

Returns

1. GuiReactUtil.ForegroundContrast

GuiReactUtil.stylingHoverClassForColor🔗

function GuiReactUtil.stylingHoverClassForColor(Vec4f): GuiReactUtil.ForegroundContrast

Parameters

• Vec4f

Returns

1. GuiReactUtil.ForegroundContrast

GuiReactUtil.makeHorizontalSpacer🔗

function GuiReactUtil.makeHorizontalSpacer(): TreeNodeId

Returns

1. TreeNodeId

GuiReactUtil.makeVerticalSpacer🔗

function GuiReactUtil.makeVerticalSpacer(): TreeNodeId

Returns

1. TreeNodeId

GuiReactUtil.makeHorizontalBox🔗

function GuiReactUtil.makeHorizontalBox({TreeNodeId}): TreeNodeId

Parameters

• {TreeNodeId}

Returns

1. TreeNodeId

GuiReactUtil.makeVerticalBox🔗

function GuiReactUtil.makeVerticalBox({TreeNodeId}): TreeNodeId

Parameters

• {TreeNodeId}

Returns

1. TreeNodeId

GuiReactUtil.transformSetUnlessEqual🔗

function GuiReactUtil.transformSetUnlessEqual<T>(state : ReactStateT<T>, newValue : T, equals : function(T, T) : boolean)

shortcut to state:transform() with an equals call for early-out

Type Parameters

• T

Parameters

• state :ReactStateT<T> — The react state
• newValue :T — The desired value
• equals :function(T, T): boolean — Optional comparison function (defaults to table_util.deepEquals

GuiReactUtil.FocusTraversalScopeParam🔗

record GuiReactUtil.FocusTraversalScopeParam
  horizontal: boolean
  vertical: boolean
  allowBubbleUp: boolean
  layout: TreeNodeId
end

GuiReactUtil.FocusTraversalScopeParam.horizontal🔗

GuiReactUtil.FocusTraversalScopeParam.horizontal: boolean

GuiReactUtil.FocusTraversalScopeParam.vertical🔗

GuiReactUtil.FocusTraversalScopeParam.vertical: boolean

GuiReactUtil.FocusTraversalScopeParam.allowBubbleUp🔗

GuiReactUtil.FocusTraversalScopeParam.allowBubbleUp: boolean

GuiReactUtil.FocusTraversalScopeParam.layout🔗

GuiReactUtil.FocusTraversalScopeParam.layout: TreeNodeId

GuiReactUtil.FocusTraversalScope🔗

GuiReactUtil.FocusTraversalScope: Recipe<FocusTraversalScopeParam>

GuiReactUtil.InputActionComponentParam🔗

record GuiReactUtil.InputActionComponentParam
  iaOrder: {string}
  iaForwards: {string : React.IaForward}
  iaHandlers: {string : React.IaHandler}
  layout: TreeNodeId
end

GuiReactUtil.InputActionComponentParam.iaOrder🔗

GuiReactUtil.InputActionComponentParam.iaOrder: {string}

GuiReactUtil.InputActionComponentParam.iaForwards🔗

GuiReactUtil.InputActionComponentParam.iaForwards: {string : React.IaForward}

GuiReactUtil.InputActionComponentParam.iaHandlers🔗

GuiReactUtil.InputActionComponentParam.iaHandlers: {string : React.IaHandler}

GuiReactUtil.InputActionComponentParam.layout🔗

GuiReactUtil.InputActionComponentParam.layout: TreeNodeId

GuiReactUtil.InputActionComponent🔗

GuiReactUtil.InputActionComponent: Recipe<InputActionComponentParam>

GuiReactUtil.EmoteIconParam🔗

[Expand All] [Collapse All]
record GuiReactUtil.EmoteIconParam
  
enum Satisfaction
    "Aloof"
    "Happy"
    "Sad"
end
  satisfaction: Satisfaction
  tooltip: string
  forceFocusable: boolean
end

GuiReactUtil.EmoteIconParam.Satisfaction🔗

enum GuiReactUtil.EmoteIconParam.Satisfaction
  "Aloof"
  "Happy"
  "Sad"
end

GuiReactUtil.EmoteIconParam.Satisfaction."Aloof"🔗

GuiReactUtil.EmoteIconParam.Satisfaction."Happy"🔗

GuiReactUtil.EmoteIconParam.Satisfaction."Sad"🔗

GuiReactUtil.EmoteIconParam.satisfaction🔗

GuiReactUtil.EmoteIconParam.satisfaction: Satisfaction

GuiReactUtil.EmoteIconParam.tooltip🔗

GuiReactUtil.EmoteIconParam.tooltip: string

GuiReactUtil.EmoteIconParam.forceFocusable🔗

GuiReactUtil.EmoteIconParam.forceFocusable: boolean

GuiReactUtil.EmoteIcon🔗

GuiReactUtil.EmoteIcon: Recipe<EmoteIconParam>

GuiReactUtil.PluginScopeConfig🔗

record GuiReactUtil.PluginScopeConfig
  firstRef: ReactRefWrap
  lastRef: ReactRefWrap
  insertHardcoded: {integer : {TreeNodeId}}
end

Parameter collection for usePlugins()

GuiReactUtil.PluginScopeConfig.firstRef🔗

GuiReactUtil.PluginScopeConfig.firstRef: ReactRefWrap

if present, filled with a nodeRef to the first (top) plugin

GuiReactUtil.PluginScopeConfig.lastRef🔗

GuiReactUtil.PluginScopeConfig.lastRef: ReactRefWrap

if present, filled with a nodeRef to the last (bottom) plugin

GuiReactUtil.PluginScopeConfig.insertHardcoded🔗

GuiReactUtil.PluginScopeConfig.insertHardcoded: {integer : {TreeNodeId}}

insert subtrees that are not plugins ( {order : {tree}} )

GuiReactUtil.usePlugins(ExtensionPoint<ParamType>, PluginScopeConfig, ParamType)🔗

function GuiReactUtil.usePlugins(ExtensionPoint<ParamType>, PluginScopeConfig, ParamType)<ParamType>(ExtensionPoint<ParamType>, PluginScopeConfig, ParamType): {TreeNodeId}

Type Parameters

• ParamType

Parameters

• ExtensionPoint<ParamType>
• PluginScopeConfig
• ParamType

Returns

1. {TreeNodeId}

GuiReactUtil.usePlugins(WrapperExtensionPoint<WrappedRecipe, ParamType>, PluginScopeConfig, ParamType)🔗

function GuiReactUtil.usePlugins(WrapperExtensionPoint<WrappedRecipe, ParamType>, PluginScopeConfig, ParamType)<WrappedRecipe, ParamType>(WrapperExtensionPoint<WrappedRecipe, ParamType>, PluginScopeConfig, ParamType): {TreeNodeId}

Type Parameters

• WrappedRecipe
• ParamType

Parameters

• WrapperExtensionPoint<WrappedRecipe, ParamType>
• PluginScopeConfig
• ParamType

Returns

1. {TreeNodeId}

GuiReactUtil.usePlugins(ExtensionPoint0, PluginScopeConfig)🔗

function GuiReactUtil.usePlugins(ExtensionPoint0, PluginScopeConfig)(ExtensionPoint0, PluginScopeConfig): {TreeNodeId}

Parameters

• ExtensionPoint0
• PluginScopeConfig

Returns

1. {TreeNodeId}

GuiReactUtil.usePlugins(WrapperExtensionPoint0<WrappedRecipe>, PluginScopeConfig)🔗

function GuiReactUtil.usePlugins(WrapperExtensionPoint0<WrappedRecipe>, PluginScopeConfig)<WrappedRecipe>(WrapperExtensionPoint0<WrappedRecipe>, PluginScopeConfig): {TreeNodeId}

Type Parameters

• WrappedRecipe

Parameters

• WrapperExtensionPoint0<WrappedRecipe>
• PluginScopeConfig

Returns

1. {TreeNodeId}