Differences

This shows you the differences between two versions of the page.

--- 4rpl:commands:func_uicallback [2021/01/14 10:51] – virgilw
+++ 4rpl:commands:func_uicallback [2021/01/15 08:15] (current) – added headers and an example Sanian
@@ Line 2: / Line 2: @@
 <=[[4rpl:start| Index]]
-":_UICallback" is invoked whenever a control panel UI element is changed. The control panel UI elements for a unit are part of its UI definitions in the CMod settings. Whenever a UI element is changed by the player, any script on the unit with :_UICallback (note the underscore) will have the function called.
+====== :_UICallback ======
-There is an implicit variable named "_DATA" that is available for use when the callback is made. For this callback, _DATA is an int that points to the UI slot that was changed. 0 refers to the first slot, 1 the 2nd, etc.
+===== Description =====
-See: [[4rpl:commands:getunituistate]] for an example and further information
+":_UICallback" is invoked whenever a control panel UI element is changed. The control panel UI elements for a unit are part of its UI definitions in the CMod settings. Whenever a UI element is changed by the player, any script on the unit with **:_UICallback** (note the underscore) will have the function called.
+There is an implicit variable named "_DATA" that is available for use when the callback is made. For this callback, **_DATA** is an int that points to the UI slot that was changed. 0 refers to the first slot, 1 the 2nd, etc.
+See: [[4rpl:commands:getunituistate|GetUnitUIState]] for further information
+===== Example =====
+<code 4rpl>
+#:_UICALLBACK is called on any script (if present) whenever a UI widget is changed.
+:_UICALLBACK
+   #The _DATA is an int that points to the slot that was just changed
+   GetUnitUIState(self <-_DATA) ->slotState
+   printallsp("UICALLBACK: " <-slotState)
+</code>

Knuckle Cracker Wiki

User Tools

Site Tools

Differences

Page Tools