Module ORGM.Client.Callbacks

Callback Functions for various events.

All of these are triggered by various events, defined in ORGMClientEvents.lua

Info:

  • Copyright: 2018 File: server/1LoadOrder/ORGMClientCallbacks.lua
  • Release: v3.09
  • Author: Fenris_Wolf

Functions

onBoot () Triggered by the OnGameBoot Event.
onStart () Triggered by the OnGameStart Event.
playerUpdate (player) Triggered by the OnPlayerUpdate Event.
keyPress (key) Triggered by the OnKeyPress Event.
restoreSettings () Triggered by the OnMainMenuEnter Event.
requestSettings (ticks) Triggered by the OnTick Event.
serverCommand (module, command, args) Triggered by the OnServerCommand Event.
inventoryMenu (player, context, items) Triggered by the OnFillInventoryObjectContextMenu Event.


Functions

onBoot ()
Triggered by the OnGameBoot Event.

This calls ORGM.Client.loadModels and Client.loadCompatibilityPatches

onStart ()
Triggered by the OnGameStart Event.
playerUpdate (player)
Triggered by the OnPlayerUpdate Event.

Parameters:

  • player IsoPlayer
keyPress (key)
Triggered by the OnKeyPress Event.

Parameters:

  • key int
restoreSettings ()
Triggered by the OnMainMenuEnter Event.

This restores a clients original ORGM settings.

requestSettings (ticks)
Triggered by the OnTick Event.

Requests the ORGM.Settings table from the server.

This is only triggered on the first tick, it seems sendClientCommand will not properly trigger OnGameStart (GameClient.bIngame is false?). Removes itself from the event queue after.

Credits to Dr_Cox1911 for the OnTick trick in his CoxisReloadSync mod.

Parameters:

  • ticks
serverCommand (module, command, args)
Triggered by the OnServerCommand Event.

Parameters:

inventoryMenu (player, context, items)
Triggered by the OnFillInventoryObjectContextMenu Event.

Parameters:

  • player int
  • context table
  • items ItemStack
generated by LDoc 1.4.3 Last updated 2018-10-07 13:48:49