Code Modding - Revision history

Khornel: /* Button in the main HUD */

2026-04-14T17:19:50Z

Button in the main HUD

Khornel: /* HTML-like UI */

2026-03-27T07:47:06Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-27T07:46:12Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-26T13:23:59Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-26T13:23:50Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-26T13:22:36Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-26T07:56:00Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-26T07:55:32Z

HTML-like UI

Khornel: /* HTML-like UI */

2026-03-26T07:55:05Z

HTML-like UI

Khornel: /* Networking */

2026-03-25T21:25:17Z

Networking

@@ Line 151: / Line 151: @@
 == Creating UI ==
 === Button in the main HUD ===
-You can add buttons to the bottom main HUD by calling '''HUD.Instance.AddBottomButton'''(string panel, string name, string desc, Sprite icon). If you want your own Icon you need to instantiate a Sprite with a texture that you load using '''ParentMod.LoadTexture''' or in the '''ModMeta''''s '''Initialize'''(ModController.DLLMod parentMod) method. The game uses 32x32 icons that are completely white with a transparent background, if you want to stay consistent.
+You can add buttons to the bottom main HUD by calling '''HUD.Instance.AddBottomButton'''(string panel, string name, string desc, Sprite icon). You can use one of the built-in icons by calling '''ObjectDatabase.Instance.GetIcon'''(name) and use the console command '''SHOW_ICONS''' to see all the built-in icons, or if you want your own Icon you need to instantiate a Sprite with a texture that you load using '''ParentMod.LoadTexture''' or in the '''ModMeta''''s '''Initialize'''(ModController.DLLMod parentMod) method. The game uses 32x32 icons that are completely white with a transparent background, if you want to stay consistent.
 === HTML-like UI ===

@@ Line 155: / Line 155: @@
 === HTML-like UI ===
 You can load in UIs using xml files with an html like structure using '''WindowManager.GenerateUI'''(List<XMLParser.XMLNode> nodes, GameObject parent, ModBehaviour callback). Example:
-<pre class="language-html"><window MinSize="0,0" NonLocTitle="Test window">
+<pre class="language-html"><Window MinSize="0,0" NonLocTitle="Test window">
-	<scrollview anchor="fill" position="4,4" size="-8,-8">
+	<ScrollView anchor="fill" position="4,4" size="-8,-8">
 		<VerticalLayout anchor="top" padding="4,4,4,4" spacing="2" childForceExpandHeight="False" childControlHeight="False">
 			<ContentFitter verticalFit="PreferredSize">
-				<label id="lab" color="FF0000" height="24">Hello</label>
+				<Label id="lab" color="FF0000" height="24">Hello</Label>
-				<button onClick="ShowMessage(Hehe)" height="24">Click me</button>
+				<Button onClick="ShowMessage(Hehe)" height="24">Click me</Button>
-				<combo OnSelectedChanged="ShowMessageCombo(this)" height="24">a,b,c</combo>
+				<Combo OnSelectedChanged="ShowMessageCombo(this)" height="24">a,b,c</Combo>
 			</ContentFitter>
 		</VerticalLayout>
-	</scrollview>
+	</ScrollView>
-</window></pre>
+</Window></pre>
 This will create a window with a scroll view containing a label, a button and a combobox automatically laid out vertically. Please note that attributes, e.g. '''position'''="4,4" are case sensitive!

@@ Line 154: / Line 154: @@
 === HTML-like UI ===
-You can load in UIs using xml files with an html like structure using '''WindowManager.GenerateUI'''(List<XMLParser.XMLNode> nodes, GameObject parent, object callback). Example:
+You can load in UIs using xml files with an html like structure using '''WindowManager.GenerateUI'''(List<XMLParser.XMLNode> nodes, GameObject parent, ModBehaviour callback). Example:
 <pre class="language-html"><window MinSize="0,0" NonLocTitle="Test window">
 	<scrollview anchor="fill" position="4,4" size="-8,-8">

@@ Line 176: / Line 176: @@
 var label = (Text)elements["lab"];
 Debug.log(label.text);
 public void ShowMessage(string x)
+	{

@@ Line 172: / Line 172: @@
 You can also use the '''id''' attribute to reference the element in your code after the UI has been loaded.
-The game will try to find a corrosponding variable to set for the element for any other attributes you use (Remember case sensitivity). Some elements, like the '''button''', '''input''' and '''combo''' have event variables, i.e. '''onClick''', '''onValueChanged''' and '''OnSelectedChanged''' (use visual studio's code lookup feature to see what is possible), these can be set to function calls that will be called directly on an object you set when creating the UI, i.e. the  onClick="ShowMessage(Hehe)" part. Here's an example of how you would create and use this UI:
+The game will try to find a corrosponding variable to set for the element for any other attributes you use (Remember case sensitivity). Some elements, like the '''button''', '''input''' and '''combo''' have event variables, i.e. '''onClick''', '''onValueChanged''' and '''OnSelectedChanged''' (use visual studio's code lookup feature to see what is possible), these can be set to function calls that will be called directly on an object you set when creating the UI, i.e. the  onClick="ShowMessage(Hehe)" and OnSelectedChanged="ShowMessageCombo(this)" part. Note that using "this" will refer to the actual component the tag represents. Here's an example of how you would create and use this UI:
 <pre class="language-cs">var elements = WindowManager.GenerateUI(ParentMod.LoadFullXMLFile("UI.xml"), null, this);
 var label = (Text)elements["lab"];
@@ Line 179: / Line 179: @@
+	{
 	WindowManager.Instance.ShowMessageBox(x, true, DialogWindow.DialogType.Information);
 	}</pre>

@@ Line 209: / Line 209: @@
 * layoutelement (see https://docs.unity3d.com/2018.2/Documentation/ScriptReference/UI.LayoutElement.html)
-Note that when adding elements or layouts to a window or scrollview, you are not adding it directly to the window or scrollview, but their content panels. For the rest of the elements, children tags are added directly to the element.
+Note that when adding tags to a window or scrollview, you are not adding it directly to the window or scrollview, but their content panels. For the rest of the elements, children tags are added directly to the element.
 == Networking ==

@@ Line 212: / Line 212: @@
 To send data to players in multiplayer you first need to call '''ParentMod.RegisterNetworkID'''(id) in a ModBehaviour. The id should be a value between 1-255, it will be used to identify messages to and from your mod, so you should pick a unique number that is unlikely to clash with other mods. When your mod is deactivated, the id will automatically be de-registered and will have to be re-registered to work. Please note that if players don't enable code mods when they host a game, all code mods will be deactivated immediately.
-To send messages you have to call '''ParentMod.SendNetworkMessage'''(byte[] data, ModBehaviour.MessageTarget target, byte targetID) in your ModBehaviour, where target can be '''everyone'''(default), '''everyone but me'''(so avoid sending message to self), '''everyone except'''(everyone except player with targetID), '''specifically''' (only player with targetID) and '''host'''. For performance reasons, I recommend instantiating a '''MemoryStream''' when your mod first loads and when you want to send data call MemoryStream.SetLength(0) to reset its data and then use the extension methods that Software Inc. comes with to write arbitrary data to the stream. Finally call MemoryStream.ToArray() to send the data. Please be careful about how much data you send, you should keep the packages as small as possible.
+To send messages you have to call '''ParentMod.SendNetworkMessage'''(byte[] data, ModBehaviour.MessageTarget target, byte targetID) in your ModBehaviour, where target can be '''everyone'''(default), '''everyone but me'''(so avoid sending message to self), '''everyone except'''(everyone except player with targetID), '''specifically''' (only player with targetID) and '''host'''. For performance reasons, I recommend instantiating a '''MemoryStream''' when your mod first loads and when you want to send data call '''MemoryStream.SetLength'''(0) to reset its data and then use the extension methods that Software Inc. comes with to write arbitrary data to the stream. Finally call '''MemoryStream.ToArray'''() to send the data. Please be careful about how much data you send, you should keep the packages as small as possible.
 When you want to receive data, override '''ModMeta.ReceiveNetworkMessage'''(SINetworking.NetworkPlayer player, MemoryStream stream), and just use the Stream extension methods to turn the bytes in the MemoryStream back into data you use, in the same order you sent it.