UIList.new

Inputs:

  • parentSizer [UISizer]:
  • xPosition [integer?]: [optional, default=-1]
  • yPosition [integer?]: [optional, default=-1]
  • width [integer?]: [optional, default=-1]
  • height [integer?]: [optional, default=-1]
  • borderDirection [integer?]: (BorderDirection.ALL, BorderDirection.TOP, BorderDirection.BOTTOM, BorderDirection.LEFT or BorderDirection.RIGHT) [optional, default=BorderDirection.NONE]
  • borderSize [integer?]: in pixels [optional, default=0]
  • proportion [integer?]: [optional, default=0]

Outputs:

  • uiList [UIList]:

UIList:appendItem

Inputs:

  • Label [string]:

Outputs:

  • itemId [integer]: The id of the newly inserted item

UIList:clear

UIList:destroy

UIList:getEnabled

Outputs:

  • [boolean]:

UIList:getItemCount

Outputs:

  • count [integer]:

UIList:getItemText

Inputs:

  • itemId [integer]: The id of the item for which the text should be retrieved

Outputs:

  • text [string]: Label of the item

UIList:getSelectedItem

Outputs:

  • itemId [integer]: The id of the currently selected item

UIList:isVisible

Outputs:

  • [boolean]:

UIList:removeItem

Inputs:

  • itemId [integer]: The id of the item to be removed

UIList:setEnabled

Inputs:

  • enabled [boolean?]: [optional, default=true]

UIList:setItemBackgroundColor

Inputs:

  • itemId [integer]: The id of the item for which the background color should be set
  • red [float]: red (0.0 - 1.0)
  • green [float]: green (0.0 - 1.0)
  • blue [float]: blue (0.0 - 1.0)
  • alpha [float?]: alpha (0.0 - 1.0) [optional, default=1.0]

UIList:setItemTextColor

Inputs:

  • itemId [integer]: The id of the item for which the text color should be set
  • red [float]: red (0.0 - 1.0)
  • green [float]: green (0.0 - 1.0)
  • blue [float]: blue (0.0 - 1.0)
  • alpha [float?]: alpha (0.0 - 1.0) [optional, default=1.0]

UIList:setOnChangeCallback

Inputs:

  • callbackFunction [object]: function(newItemId, oldItemId)
  • functionObject [object?]: functionObject [optional, default=NULL]

UIList:setSelectedItem

Inputs:

  • itemId [integer]: The id of the item to select

UIList:setToolTip

Inputs:

  • tooltip [string]:

UIList:setVisible

Inputs:

  • visible [boolean?]: [optional, default=true]

Last updated 12 Apr 2025, 16:09 +0200 . history