Module CorsixTH.CorsixTH.Lua.dialogs.resizables.options

Options window used in the main menu and ingame.

Functions

UIOptions:_getOptionYPos () Calculates the Y position for the dialog box in the option menu and increments along the current position for the next element
UIOptions:buttonUpdates () Function handles button toggle of checking for updates
UIOptions:toggleUpdateCheck () Changes check for update setting to on/of
UIResolution:UIResolution (ui, callback) A custom resolution selection window.
UIResolution:close (ok) Closes the resolution dialog
UIScrollSpeed:UIScrollSpeed (ui, callback) A window for setting the scroll speed of the camera.
UIShiftScrollSpeed:UIShiftScrollSpeed (ui, callback) A window for setting the scroll speed of the camera while pressing the SHIFT key.
UIZoomSpeed:UIZoomSpeed (ui, callback) Window to set the zoom speed of the scroll wheel while in-game.


Functions

UIOptions:_getOptionYPos ()
Calculates the Y position for the dialog box in the option menu and increments along the current position for the next element

Returns:

    The Y position to place the element at
UIOptions:buttonUpdates ()
Function handles button toggle of checking for updates
UIOptions:toggleUpdateCheck ()
Changes check for update setting to on/of
UIResolution:UIResolution (ui, callback)
A custom resolution selection window.

Parameters:

  • ui
  • callback
UIResolution:close (ok)
Closes the resolution dialog

Parameters:

  • ok (boolean or nil) whether the resolution entry was confirmed (true) or aborted (false)
UIScrollSpeed:UIScrollSpeed (ui, callback)
A window for setting the scroll speed of the camera.

Parameters:

  • ui
  • callback
UIShiftScrollSpeed:UIShiftScrollSpeed (ui, callback)
A window for setting the scroll speed of the camera while pressing the SHIFT key.

Parameters:

  • ui
  • callback
UIZoomSpeed:UIZoomSpeed (ui, callback)
Window to set the zoom speed of the scroll wheel while in-game.

Parameters:

  • ui
  • callback
generated by LDoc TESTING Last updated 2015-01-01 12:00:00