Script Hooks - Revision history

Thyraxx.void: Undo revision 14298 by Thyraxx.void (talk)

2026-04-07T23:08:28Z

Undo revision 14298 by Thyraxx.void (talk)

2026-04-07T23:05:32Z

Reverted edits by Thyraxx.void (talk) to last revision by Miss

2020-05-07T11:55:44Z

2020-01-20T16:20:34Z

2019-08-15T01:46:23Z

GameModeUpdateWidgets

2019-08-15T01:46:00Z

2019-08-12T14:42:18Z

LoadWidgetProducers

2019-08-12T14:41:56Z

2019-07-17T12:54:45Z

2018-10-09T09:31:31Z

@@ Line 71: / Line 71: @@
   void TownRecordLoad(TownRecord@ record, SValue@ sval)
 Called when the town record is being loaded. Use <code>sval</code> to deserialize data.
 == PlayerRecordSave ==

@@ Line 71: / Line 71: @@
   void TownRecordLoad(TownRecord@ record, SValue@ sval)
 Called when the town record is being loaded. Use <code>sval</code> to deserialize data.
 == PlayerRecordSave ==

@@ Line 71: / Line 71: @@
   void TownRecordLoad(TownRecord@ record, SValue@ sval)
 Called when the town record is being loaded. Use <code>sval</code> to deserialize data.
 == PlayerRecordSave ==

@@ Line 79: / Line 79: @@
   void PlayerRecordLoad(PlayerRecord@ record, SValue@ sval)
 Called when a player record is being loaded. Use <code>sval</code> to deserialize data.
 == PlayerRefreshScene ==
@@ Line 96: / Line 108: @@
 Called when widget producers should be loaded. This allows you to initialize custom widget producers that can produce custom widgets. <code>builder</code> is where you would call <code>AddWidgetProducer</code> on to initialize the widget producer.
-(Added in b100 and onwards)
+(Added since b100 and)
 [[Category:Modding]]

@@ Line 37: / Line 37: @@
   void GameModeUpdateWidgets(Campaign@ campaign, int dt, GameInput& gameInput, MenuInput& menuInput)
 Called every tick from the Campaign gamemode's widget updating function. Use this for widgets rather than <code>GameModeUpdate</code>, because this still gets called when the game is paused. Use <code>dt</code> to determine how many milliseconds have passed since the last tick. Note that ticks are different from rendered frames. Ticks typically run at a fixed rate of 30 FPS. You can use <code>gameInput</code> and <code>menuInput</code> here to get information about current controls.
 == GameModeRenderWidgets ==

@@ Line 33: / Line 33: @@
   void GameModeRenderFrame(Campaign@ campaign, int idt, SpriteBatch &sb)
 Called for each rendered frame before any UI is drawn. If you're looking for a hook called ''after'' the UI is drawn, use the <code>GameModeRenderWidgets</code> hook instead. You can use <code>sb</code> to render things to the screen. The <code>idt</code> parameter is the current time in milliseconds since the last update tick, which means the value will be between 0 and 33. Divide this value by <code>33.0f</code> to get a normalized interpolation factor for animations.
 == GameModeRenderWidgets ==

@@ Line 84: / Line 84: @@
 == WidgetHosterResourceAdded ==
   void WidgetHosterResourceAdded(Widget@ parent, Widget@ w, GUIBuilder@ b, GUIDef@ def)
-Calls when a widget adds a resource gui file via <code>AddResource</code>. <code>parent</code> is the widget that the resource was added to as a child. <code>w</code> is the root widget of the added gui file. <code>b</code> is the builder object that was used to build the widget tree. <code>def</code> is the definition of the gui file, which can be used to get any defined sprites.
+Called when a widget adds a resource gui file via <code>AddResource</code>. <code>parent</code> is the widget that the resource was added to as a child. <code>w</code> is the root widget of the added gui file. <code>b</code> is the builder object that was used to build the widget tree. <code>def</code> is the definition of the gui file, which can be used to get any defined sprites.
 [[Category:Modding]]

@@ Line 81: / Line 81: @@
   void WidgetHosterLoad(IWidgetHoster@ host, GUIBuilder@ b, GUIDef@ def)
 Called when a widget hoster loaded its gui file. <code>host</code> specifies the host object that loaded the gui file. <code>b</code> is the builder object that was used to build the widget tree. <code>def</code> is the definition of the gui file, which can be used to get any defined sprites.
 [[Category:Modding]]

@@ Line 52: / Line 52: @@
 == GameModeSpawnPlayer ==
   void GameModeSpawnPlayer(Campaign@ campaign, PlayerRecord@ record)
-Called when a player has spawned.
+Called when a player has spawned. (B90+)
 == GameModePlayerDied ==
   void GameModePlayerDied(Campaign@ campaign, PlayerRecord@ player, PlayerRecord@ killer, DamageInfo &di)
-Called when a player dies.
+Called when a player dies. (B90+)
 == TownRecordSave ==