TUTORIALS
MODDING TUTORIALS
Client - API
Client - Code Examples
Website
Server - API
Server - Code examples
Adding private variables
Adding private variables
Adding private variables to an existing Raft class is sometimes very necessary. There're many ways to add new variables. In this article we will consider the method provided by Whitebrim. (Discord Whitebrim#4444)
We will store variables in the newly created class and add an extension for original Raft class. You can read how C# extensions work here.
We need to create new
ConditionalWeakTable<TKey, TValue>. It will store our data classes and link them to original classes. This class is specifically created for our case, if you're interested you can read more about it here.In this example we will add new
private bool isLocked variable to SteeringWheel class:First, we need to create data class to store all data we need to add:
1
[Serializable]
2
public class SteeringWheelAdditionalData
3
{
4
public bool isLocked;
5
​
6
public SteeringWheelAdditionalData()
7
{
8
isLocked = false;
9
}
10
}
Copied!
You must add
[Serializable] attribute that our class could be saved. Also you need to create default constructor with no parameters to initialize class with default values.Second, we need to create an extension class to store and handle data:
1
public static class SteeringWheelExtension
2
{
3
private static readonly ConditionalWeakTable<SteeringWheel, SteeringWheelAdditionalData> data =
4
new ConditionalWeakTable<SteeringWheel, SteeringWheelAdditionalData>();
5
​
6
public static SteeringWheelAdditionalData GetAdditionalData(this SteeringWheel steeringWheel)
7
{
8
return data.GetOrCreateValue(steeringWheel);
9
}
10
​
11
public static void AddData(this SteeringWheel steeringWheel, SteeringWheelAdditionalData value)
12
{
13
try
14
{
15
data.Add(steeringWheel, value);
16
}
17
catch (Exception) { }
18
}
19
}
Copied!
Then you need to patch original class. In our case we need to change displaying text depending on
IsLocked state. We will patch OnIsRayed() method inside SteeringWheel class:1
[HarmonyPatch(typeof(SteeringWheel), "OnIsRayed")]
2
class SteeringWheelPatchOnIsRayed
3
{
4
private static void Postfix(SteeringWheel __instance, ref DisplayTextManager ___displayText)
5
{
6
if (!__instance.GetAdditionalData().isLocked)
7
___displayText.ShowText("Press to LOCK rotation", MyInput.Keybinds["RMB"].MainKey, 2, 0, false);
8
else
9
___displayText.ShowText("Press to UNLOCK rotation", MyInput.Keybinds["RMB"].MainKey, 2, 0, false);
10
​
11
if (MyInput.GetButtonDown("RMB"))
12
__instance.GetAdditionalData().isLocked = !__instance.GetAdditionalData().isLocked; // Toggle bool
13
}
14
}
Copied!
Also you need to apply patch:
1
public class BetterSteeringWheel : Mod
2
{
3
private HarmonyInstance harmonyInstance;
4
​
5
public void Start()
6
{
7
harmonyInstance = new Harmony("com.whitebrim.bettersteeringwheel"); // It's custom patch name, you need to name your patch differently
8
harmonyInstance.PatchAll(Assembly.GetExecutingAssembly());
9
}
10
​
11
public void OnModUnload()
12
{
13
harmonyInstance.UnpatchAll();
14
Destroy(gameObject);
15
}
16
}
Copied!
You can access new data using class instance.
SteeringWheel.GetAdditionalData().Example for
float and string:1
[Serializable]
2
public class YourClassAdditionalData
3
{
4
public float floatVar;
5
public string stringVar;
6
​
7
public CustomClassAdditionalData()
8
{
9
floatVar = 0;
10
stringVar = "None";
11
}
12
}
13
​
14
public static class CustomExtension // Nothing changed :)
15
{
16
private static readonly ConditionalWeakTable<YourClass, YourClassAdditionalData> data =
17
new ConditionalWeakTable<YourClass, YourClassAdditionalData>();
18
​
19
public static YourClassAdditionalData GetAdditionalData(this YourClass yourClass)
20
{
21
return data.GetOrCreateValue(yourClass);
22
}
23
​
24
public static void AddData(this YourClass yourClass, YourClassAdditionalData value)
25
{
26
try
27
{
28
data.Add(yourClass, value);
29
}
30
catch (Exception) { }
31
}
32
}
Copied!
Saving private variables
To save private variables you need to patch
RDG_%RaftClassName% class and method that is invoked inside switch in SaveAndLoad class in RestoreRGDGame(RGD_Game game) method.In this example we will use
SteeringWheel class and save data from Adding private variables section.First, we have to add new link
RGD Class -> our additional data class (ConditionalWeakTable):1
public static class SteeringWheelExtension
2
{
3
public static ConditionalWeakTable<RGD_SteeringWheel, SteeringWheelAdditionalData> RGD_data =
4
new ConditionalWeakTable<RGD_SteeringWheel, SteeringWheelAdditionalData>();
5
​
6
public static void AddData(this RGD_SteeringWheel RGD_SteeringWheel, SteeringWheelAdditionalData value)
7
{
8
try
9
{
10
RGD_data.Add(RGD_SteeringWheel, value);
11
}
12
catch (Exception) { }
13
}
14
}
Copied!
Second, we need to patch
RGD_SteeringWheel class. There're two constructors (one for saving, another for loading) and GetObjectData method (to control flow of Serialization).1
class RGD_SteeringWheelPatch
2
{
3
[HarmonyPatch(typeof(RGD_SteeringWheel), MethodType.Constructor, new Type[]{ typeof(RGDType), typeof(SteeringWheel) })]
4
class RGD_SteeringWheelConstructor1 // Constructor for saving
5
{
6
private static void Prefix(RGD_SteeringWheel __instance, ref SteeringWheel steeringWheel)
7
{
8
__instance.AddData(steeringWheel.GetAdditionalData());
9
}
10
}
11
​
12
[HarmonyPatch(typeof(RGD_SteeringWheel), MethodType.Constructor, new Type[] { typeof(SerializationInfo), typeof(StreamingContext) })]
13
class RGD_SteeringWheelConstructor2 // Constructor for loading
14
{
15
private static void Prefix(RGD_SteeringWheel __instance, ref SerializationInfo info)
16
{
17
try
18
{
19
__instance.AddData(JsonUtility.FromJson<SteeringWheelAdditionalData>(info.GetString("AdditionalData"))); // Loads from Json that we will create in GetObjectData
20
}
21
catch (Exception) { }
22
}
23
}
24
​
25
[HarmonyPatch(typeof(RGD_SteeringWheel), "GetObjectData")]
26
class GetObjectData // Interfering with the serialization flow and adding our custom data to the save
27
{
28
private static void Postfix(RGD_SteeringWheel __instance, ref SerializationInfo info)
29
{
30
SteeringWheelAdditionalData value;
31
if (SteeringWheelExtension.RGD_data.TryGetValue(__instance, out value))
32
info.AddValue("AdditionalData", JsonUtility.ToJson(value)); // We need to use json because worlds loads before mod compiles
33
}
34
}
35
}
Copied!
Lastly, we need to find method that loads saved block data and patch it. This method is invoked inside switch in
SaveAndLoad class in RestoreRGDGame(RGD_Game game) method:1
switch (rgd.type)
2
{
3
case RGDType.Block:
4
{
5
// Important code
6
break;
7
}
8
case RGDType.Block_Door:
9
{
10
// Important code
11
break;
12
}
13
// etc...
Copied!
Our case:
1
case RGDType.Block_SteeringWheel:
2
{
3
RGD_SteeringWheel rgd_SteeringWheel = rgd as RGD_SteeringWheel;
4
Block block19 = this.RestoreBlock(network_Player.BlockCreator, rgd_SteeringWheel);
5
if (block19 != null)
6
{
7
SteeringWheel componentInChildren3 = block19.GetComponentInChildren<SteeringWheel>();
8
if (componentInChildren3 != null)
9
{
10
componentInChildren3.RestoreWheel(rgd_SteeringWheel); // <- This line
11
}
12
}
13
break;
14
}
Copied!
In our case method is called
RestoreWheel(RGD_SteeringWheel rgdWheel). This method contains instructions on how to deserialize RGD class to retrieve saved data. We will add our custom instructions:1
[HarmonyPatch(typeof(SteeringWheel), "RestoreWheel")]
2
class SteeringWheelRestoreWheelPatch
3
{
4
private static void Prefix(SteeringWheel __instance, RGD_SteeringWheel rgdWheel)
5
{
6
SteeringWheelAdditionalData value;
7
if (SteeringWheelExtension.RGD_data.TryGetValue(rgdWheel, out value))
8
__instance.AddData(value);
9
}
10
}
Copied!
Congratulations, our custom data for Steering Wheel is saving and loading successfully.
Copy link