Scripting Events - Revision history

Nerf cardboard: move to Category:Modding

2023-06-10T11:48:44Z

move to Category:Modding

← Older revision		Revision as of 11:48, 10 June 2023
Line 1:		Line 1:
	The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.		The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

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

	== Eventor Events ==		== Eventor Events ==

Nerf cardboard: add some event types

2023-02-21T15:57:11Z

add some event types

← Older revision		Revision as of 15:57, 21 February 2023
Line 8:		Line 8:
	The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:		The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:
	* None		* None
	* New_Connection		* New_Connection (GlobalPlayerConnectionEvent)
	* Created		* Created
	* Destroyed		* Destroyed
Line 14:		Line 14:
	* Add_Player		* Add_Player
	* Remove_Player		* Remove_Player
	* Player_Joined		* Player_Joined (GlobalPlayerEvent has .Player)
	* Player_Assigned		* Player_Assigned
	* Player_Left		* Player_Left
Line 23:		Line 23:
	* Impacted		* Impacted
	* Weapon_Selected		* Weapon_Selected
	* Trigger		* Trigger (GlobalTriggerEvent)
	* Match_Waiting		* Match_Waiting
	* Match_Warmup		* Match_Warmup
	* Match_Started		* Match_Started
	* Match_Ended		* Match_Ended
	* Hit		* Hit (GlobalHitEvent)
	* Camera_Target_Changed		* Camera_Target_Changed
	* Camera_Created		* Camera_Created
Line 42:		Line 42:
	* Construct_RemoveBody		* Construct_RemoveBody
	* Properties_Changed		* Properties_Changed
	* Item_Dropped		* Item_Dropped (GlobalItemEvent has .Item and .Holder)
	* Item_Picked		* Item_Picked (GlobalItemEvent has .Item and .Holder)
	* AssignedNetworkId		* AssignedNetworkId
	* Changed_Team		* Changed_Team

AL at 14:03, 2 February 2023

2023-02-02T14:03:11Z

← Older revision		Revision as of 14:03, 2 February 2023
Line 64:		Line 64:
	foreach (Player player in Players.Get.GetAlive())		foreach (Player player in Players.Get.GetAlive())
	{		{
	// for each (player,checkpoint) pair, check if the distance is less than 1.5		// for each (player,checkpoint) pair, check if the distance between them is less than 1.5
	if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)		if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)
	{		{

AL at 14:02, 2 February 2023

2023-02-02T14:02:28Z

← Older revision		Revision as of 14:02, 2 February 2023
Line 56:		Line 56:
	* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>		* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

	If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine.		If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine. For example, something equivalent to this is used in the official <code>Climb.cs</code> script to detect when any player gets within 1.5 range of a checkpoint:
			<syntaxhighlight lang="C#">
			void FixedUpdate() // runs 10 times per second
			{
			for (int i = checkpoints.Count - 1; i >= 0; i--)
			{
			foreach (Player player in Players.Get.GetAlive())
			{
			// for each (player,checkpoint) pair, check if the distance is less than 1.5
			if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)
			{
			checkpoints.RemoveAt(i);
			lastCheckpointPlayer = player;
			break;
			}
			}
			}
			}
			</syntaxhighlight>

Nerf cardboard at 11:55, 19 January 2023

2023-01-19T11:55:40Z

← Older revision		Revision as of 11:55, 19 January 2023
Line 1:		Line 1:
	The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.		The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

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

Nerf cardboard: add Modding & Scripting categories

2023-01-19T11:43:12Z

add Modding & Scripting categories

← Older revision		Revision as of 11:43, 19 January 2023
Line 1:		Line 1:
	The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.		The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

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

	== Eventor Events ==		== Eventor Events ==

AL at 15:51, 16 January 2023

2023-01-16T15:51:29Z

← Older revision		Revision as of 15:51, 16 January 2023
Line 54:		Line 54:
	* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>		* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

	If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically.		If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine.

AL at 15:50, 16 January 2023

2023-01-16T15:50:41Z

← Older revision		Revision as of 15:50, 16 January 2023
Line 54:		Line 54:
	* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>		* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

	If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update</code> or <code>FixedUpdate</code> functions which are called periodically.		If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically.

AL at 15:50, 16 January 2023

2023-01-16T15:50:23Z

← Older revision		Revision as of 15:50, 16 January 2023
Line 53:		Line 53:
	Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:		Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:
	* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>		* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

			If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update</code> or <code>FixedUpdate</code> functions which are called periodically.

AL at 15:42, 16 January 2023

2023-01-16T15:42:25Z

← Older revision		Revision as of 15:42, 16 January 2023
Line 48:		Line 48:
	* Reserved		* Reserved

	A full example of an AddListener call is <code>Eventor.AddListener(Events.Died, OnPlayerDied);</code>. These calls are usually placed within the <code>Awake()</code> function of the script, which is executed when the script is loaded. Note that each AddListener call should be paired with a RemoveListener call (usually in the <code>OnDestroy()</code> function) to ensure that the script does not continue to respond to events after it has been disabled. See the Unity manual entry for the [https://docs.unity3d.com/2020.1/Documentation/ScriptReference/MonoBehaviour.html MonoBehaviour] class for other special functions.		A full example of an AddListener call is <code>Eventor.AddListener(Events.Died, OnPlayerDied)</code>. These calls are usually placed within the <code>Awake()</code> function of the script, which is executed when the script is loaded. Note that each AddListener call should be paired with a RemoveListener call (usually in the <code>OnDestroy()</code> function) to ensure that the script does not continue to respond to events after it has been disabled. See the Unity manual entry for the [https://docs.unity3d.com/2020.1/Documentation/ScriptReference/MonoBehaviour.html MonoBehaviour] class for other special functions.

	== Other Events ==		== Other Events ==
	Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:		Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:
	* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>		* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>