Scripting Introduction - Revision history

Nerf cardboard: move to Category:Modding

2023-06-10T11:47:41Z

move to Category:Modding

← Older revision		Revision as of 11:47, 10 June 2023
Line 1:		Line 1:
	Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the <i>GameScript</i> object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.		Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the <i>GameScript</i> object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

	[[Category:~~Scripting~~]]		[[Category:Modding]]

Nerf cardboard: document how to parametrize scripts in game modes

2023-03-07T15:24:09Z

document how to parametrize scripts in game modes

← Older revision		Revision as of 15:24, 7 March 2023
Line 46:		Line 46:
	=== In a rule / game mode ===		=== In a rule / game mode ===

	Add ~~the~~ script name to the <code>~~GameRules~~</code> ~~section of~~ the ~~rule definition in~~ <code>~~Rules/Custom/YourGameMode.json~~</code>:		To add a script to all matches of a gamemode, edit <code>Rules/Custom/YourGameMode.json</code>.

			Add a script by adding its class name as a key to the game mode definition (on the same level as <code>GameScript</code>). Inside that object, you can define parameters the script potentially exposes via <code>JSONProperty</code> tags:

	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	"~~Objects~~": {		...
	"~~YourGameMode~~": {		"GameScript": { ... },
			"YourScriptName": {
			"ExampleParameter": true,
			}
			...
			}
			</syntaxhighlight>



			An alternative way, is to add the class name of your script to the <code>GameScript.Scripts</code> array:
			<syntaxhighlight lang="JSON">
			{
			...
	"GameScript": {		"GameScript": {
	"Scripts": [		"Scripts": [
Line 59:		Line 73:
	]		]
	}		}
			...
	}
	}
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>

AL at 13:33, 2 February 2023

2023-02-02T13:33:07Z

← Older revision		Revision as of 13:33, 2 February 2023
Line 11:		Line 11:
	Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>. Some unofficial examples are available at [[Scripting Examples]].		Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>. Some unofficial examples are available at [[Scripting Examples]].

	~~More documentation is added to this wiki under~~ [[:Category:Scripting]].		See [[:Category:Scripting]] for a list of all pages on this wiki related to scripting.

	== Using Scripts ==		== Using Scripts ==

AL: /* Using Scripts */

2023-02-02T13:27:09Z

Using Scripts

← Older revision		Revision as of 13:27, 2 February 2023
Line 41:		Line 41:
	<syntaxhighlight lang="C#">		<syntaxhighlight lang="C#">
	[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;		[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
	</~~syntaxhighliight~~>		</syntaxhighlight>

AL at 13:26, 2 February 2023

2023-02-02T13:26:49Z

← Older revision		Revision as of 13:26, 2 February 2023
Line 20:		Line 20:
	Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:		Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

	<~~pre~~>		<syntaxhighlight lang="JSON">
	{		{
	"Objects": {		"Objects": {
Line 35:		Line 35:
	}		}
	}		}
	</~~pre~~>		</syntaxhighlight>

	A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:		A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

	<~~pre~~>		<syntaxhighlight lang="C#">
	[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;		[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
	</~~pre~~>		</syntaxhighliight>


Line 48:		Line 48:
	Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:		Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:

	<~~pre~~>		<syntaxhighlight lang="JSON">
	{		{
	"Objects": {		"Objects": {
Line 63:		Line 63:
	}		}
	}		}
	</~~pre~~>		</syntaxhighlight>

	* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>		* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>

AL at 13:23, 2 February 2023

2023-02-02T13:23:00Z

← Older revision		Revision as of 13:23, 2 February 2023
Line 9:		Line 9:
	There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.		There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.

	Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.		Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>. Some unofficial examples are available at [[Scripting Examples]].

	More documentation is added to this wiki under [[:Category:Scripting]].		More documentation is added to this wiki under [[:Category:Scripting]].

Nerf cardboard at 11:48, 19 January 2023

2023-01-19T11:48:11Z

← Older revision		Revision as of 11:48, 19 January 2023
Line 1:		Line 1:
	Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the <i>GameScript</i> object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.		Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the <i>GameScript</i> object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

			[[Category:Scripting]]


	== Scripting Resources ==		== Scripting Resources ==
Line 8:		Line 11:
	Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.		Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.

	[[Category:Scripting]]		More documentation is added to this wiki under [[:Category:Scripting]].

	== Using Scripts ==		== Using Scripts ==

Nerf cardboard at 11:39, 19 January 2023

2023-01-19T11:39:43Z

← Older revision		Revision as of 11:39, 19 January 2023
Line 37:		Line 37:

	<pre>		<pre>
	[JsonProperty("FlagDamagePerSecond")] public ~~int flagDPSParameter~~ = 5.0;		[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
	</pre>		</pre>

Nerf cardboard: document how to apply a script to a match

2023-01-19T11:37:50Z

document how to apply a script to a match

← Older revision		Revision as of 11:37, 19 January 2023
Line 9:		Line 9:

	[[Category:Scripting]]		[[Category:Scripting]]

			== Using Scripts ==

			A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").

			=== In a modifier ===
			Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

			<pre>
			{
			"Objects": {
			"Rules": {
			"FlagIsPoison": {
			"FlagDamagePerSecond": 3.0
			}
			}
			},
			"Meta": {
			"Description": "(applies the FlagIsPoison script)",
			"Author": "noerw",
			"Version": 1.0
			}
			}
			</pre>

			A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

			<pre>
			[JsonProperty("FlagDamagePerSecond")] public int flagDPSParameter = 5.0;
			</pre>


			=== In a rule / game mode ===

			Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:

			<pre>
			{
			"Objects": {
			"YourGameMode": {

			"GameScript": {
			"Scripts": [
			... potentially other scripts ...,
			"YourScriptName"
			]
			}

			}
			}
			}
			</pre>

			* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>

AL at 12:35, 16 January 2023

2023-01-16T12:35:46Z

← Older revision		Revision as of 12:35, 16 January 2023
Line 1:		Line 1:
	Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the <i>GameScript</i> object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.		Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the <i>GameScript</i> object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

	= Scripting Resources =		== Scripting Resources ==
	The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].		The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].

Line 7:		Line 7:

	Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.		Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.

			[[Category:Scripting]]