https://wiki.soldat2.com/api.php?action=feedcontributions&feedformat=atom&user=ALSoldat2 Wiki - User contributions [en]2026-05-05T15:48:38ZUser contributionsMediaWiki 1.38.4https://wiki.soldat2.com/index.php?title=User:AL&diff=120User:AL2023-02-10T13:43:21Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.input.GetPointer(Pointer.AimWorld)</code> returns a Vector3 of the position of the player's cursor (in world coordinates)<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument (how much it changed by)<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>UnityEngine.Time.timeScale</code> can be used to change the speed at which the game runs, 1=normal, 2=double speed, 0.5=half speed, etc<br />
* <code>RespawningCommon.KillAllRespawnAll()</code> kill all players<br />
* <code>GetComponent<StandardRespawning>().allowRespawning</code> set to false to control whether players can automatically respawn<br />
* <code>GamesCycle.instance.game.rules</code> the name of the current rules set being used (ie gamemode)</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=119User:AL2023-02-10T13:30:37Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.input.GetPointer(Pointer.AimWorld)</code> returns a Vector3 of the position of the player's cursor (in world coordinates)<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>UnityEngine.Time.timeScale</code> can be used to change the speed at which the game runs, 1=normal, 2=double speed, 0.5=half speed, etc<br />
* <code>RespawningCommon.KillAllRespawnAll()</code> kill all players<br />
* <code>GetComponent<StandardRespawning>().allowRespawning</code> set to false to control whether players can automatically respawn<br />
* <code>GamesCycle.instance.game.rules</code> the name of the current rules set being used (ie gamemode)</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=118User:AL2023-02-10T13:30:12Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.input.GetPointer(Pointer.AimWorld)</code> returns a Vector3 of the position of the player's cursor (in world coordinates)<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server<br />
* <code>UnityEngine.Time.timeScale</code> can be used to change the speed at which the game runs, 1=normal, 2=double speed, 0.5=half speed, etc<br />
* <code>RespawningCommon.KillAllRespawnAll()</code> kill all players<br />
* <code>GetComponent<StandardRespawning>().allowRespawning</code> set to false to control whether players can automatically respawn<br />
* <code>GamesCycle.instance.game.rules</code> the name of the current rules set being used (ie gamemode)</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=106Scripting Events2023-02-02T14:03:11Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
[[Category:Scripting]]<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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><br />
<br />
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:<br />
<syntaxhighlight lang="C#"><br />
void FixedUpdate() // runs 10 times per second<br />
{<br />
for (int i = checkpoints.Count - 1; i >= 0; i--)<br />
{<br />
foreach (Player player in Players.Get.GetAlive())<br />
{<br />
// for each (player,checkpoint) pair, check if the distance between them is less than 1.5<br />
if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)<br />
{<br />
checkpoints.RemoveAt(i);<br />
lastCheckpointPlayer = player;<br />
break;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=105Scripting Events2023-02-02T14:02:28Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
[[Category:Scripting]]<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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><br />
<br />
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:<br />
<syntaxhighlight lang="C#"><br />
void FixedUpdate() // runs 10 times per second<br />
{<br />
for (int i = checkpoints.Count - 1; i >= 0; i--)<br />
{<br />
foreach (Player player in Players.Get.GetAlive())<br />
{<br />
// for each (player,checkpoint) pair, check if the distance is less than 1.5<br />
if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)<br />
{<br />
checkpoints.RemoveAt(i);<br />
lastCheckpointPlayer = player;<br />
break;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=102Scripting Introduction2023-02-02T13:33:07Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
[[Category:Scripting]]<br />
<br />
<br />
== Scripting Resources ==<br />
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].<br />
<br />
There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.<br />
<br />
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]].<br />
<br />
See [[:Category:Scripting]] for a list of all pages on this wiki related to scripting.<br />
<br />
== Using Scripts ==<br />
<br />
A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").<br />
<br />
=== In a modifier ===<br />
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:<br />
<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"Objects": {<br />
"Rules": {<br />
"FlagIsPoison": {<br />
"FlagDamagePerSecond": 3.0<br />
}<br />
} <br />
},<br />
"Meta": {<br />
"Description": "(applies the FlagIsPoison script)",<br />
"Author": "noerw",<br />
"Version": 1.0<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
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:<br />
<br />
<syntaxhighlight lang="C#"><br />
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;<br />
</syntaxhighlight><br />
<br />
<br />
=== In a rule / game mode ===<br />
<br />
Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:<br />
<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"Objects": {<br />
"YourGameMode": {<br />
<br />
"GameScript": {<br />
"Scripts": [<br />
... potentially other scripts ...,<br />
"YourScriptName"<br />
]<br />
}<br />
<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=101Scripting Introduction2023-02-02T13:27:09Z<p>AL: /* Using Scripts */</p>
<hr />
<div>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.<br />
<br />
[[Category:Scripting]]<br />
<br />
<br />
== Scripting Resources ==<br />
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].<br />
<br />
There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.<br />
<br />
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]].<br />
<br />
More documentation is added to this wiki under [[:Category:Scripting]].<br />
<br />
== Using Scripts ==<br />
<br />
A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").<br />
<br />
=== In a modifier ===<br />
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:<br />
<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"Objects": {<br />
"Rules": {<br />
"FlagIsPoison": {<br />
"FlagDamagePerSecond": 3.0<br />
}<br />
} <br />
},<br />
"Meta": {<br />
"Description": "(applies the FlagIsPoison script)",<br />
"Author": "noerw",<br />
"Version": 1.0<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
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:<br />
<br />
<syntaxhighlight lang="C#"><br />
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;<br />
</syntaxhighlight><br />
<br />
<br />
=== In a rule / game mode ===<br />
<br />
Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:<br />
<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"Objects": {<br />
"YourGameMode": {<br />
<br />
"GameScript": {<br />
"Scripts": [<br />
... potentially other scripts ...,<br />
"YourScriptName"<br />
]<br />
}<br />
<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=100Scripting Introduction2023-02-02T13:26:49Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
[[Category:Scripting]]<br />
<br />
<br />
== Scripting Resources ==<br />
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].<br />
<br />
There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.<br />
<br />
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]].<br />
<br />
More documentation is added to this wiki under [[:Category:Scripting]].<br />
<br />
== Using Scripts ==<br />
<br />
A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").<br />
<br />
=== In a modifier ===<br />
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:<br />
<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"Objects": {<br />
"Rules": {<br />
"FlagIsPoison": {<br />
"FlagDamagePerSecond": 3.0<br />
}<br />
} <br />
},<br />
"Meta": {<br />
"Description": "(applies the FlagIsPoison script)",<br />
"Author": "noerw",<br />
"Version": 1.0<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
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:<br />
<br />
<syntaxhighlight lang="C#"><br />
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;<br />
</syntaxhighliight><br />
<br />
<br />
=== In a rule / game mode ===<br />
<br />
Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:<br />
<br />
<syntaxhighlight lang="JSON"><br />
{<br />
"Objects": {<br />
"YourGameMode": {<br />
<br />
"GameScript": {<br />
"Scripts": [<br />
... potentially other scripts ...,<br />
"YourScriptName"<br />
]<br />
}<br />
<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=99Scripting Introduction2023-02-02T13:23:00Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
[[Category:Scripting]]<br />
<br />
<br />
== Scripting Resources ==<br />
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].<br />
<br />
There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.<br />
<br />
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]].<br />
<br />
More documentation is added to this wiki under [[:Category:Scripting]].<br />
<br />
== Using Scripts ==<br />
<br />
A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").<br />
<br />
=== In a modifier ===<br />
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:<br />
<br />
<pre><br />
{<br />
"Objects": {<br />
"Rules": {<br />
"FlagIsPoison": {<br />
"FlagDamagePerSecond": 3.0<br />
}<br />
} <br />
},<br />
"Meta": {<br />
"Description": "(applies the FlagIsPoison script)",<br />
"Author": "noerw",<br />
"Version": 1.0<br />
}<br />
}<br />
</pre><br />
<br />
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:<br />
<br />
<pre><br />
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;<br />
</pre><br />
<br />
<br />
=== In a rule / game mode ===<br />
<br />
Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:<br />
<br />
<pre><br />
{<br />
"Objects": {<br />
"YourGameMode": {<br />
<br />
"GameScript": {<br />
"Scripts": [<br />
... potentially other scripts ...,<br />
"YourScriptName"<br />
]<br />
}<br />
<br />
}<br />
}<br />
}<br />
</pre><br />
<br />
* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Examples&diff=98Scripting Examples2023-02-02T13:21:23Z<p>AL: Created page with "This page contains a selection of unofficial scripts to demonstrate the usage of various aspects of Soldat 2's scripting API. == Team Balancer == <syntaxhighlight lang="C#"> // a basic team-balancing script to illustrate how to implement simple // chat-commands using S2 scripting // 'using' directives let you omit namespacing // eg: Player rather than the full Teal.Player using System.Collections; using System.Collections.Generic; using UnityEngine; using Teal; [Disal..."</p>
<hr />
<div>This page contains a selection of unofficial scripts to demonstrate the usage of various aspects of Soldat 2's scripting API.<br />
<br />
== Team Balancer ==<br />
<syntaxhighlight lang="C#"><br />
// a basic team-balancing script to illustrate how to implement simple<br />
// chat-commands using S2 scripting<br />
<br />
// 'using' directives let you omit namespacing<br />
// eg: Player rather than the full Teal.Player<br />
using System.Collections;<br />
using System.Collections.Generic;<br />
using UnityEngine;<br />
using Teal;<br />
<br />
[DisallowMultipleComponent]<br />
<br />
// the class name as defined here is what you need to refer to in any json<br />
// config files, NOT the name of this script file. Case sensitive.<br />
public class Balance : MonoBehaviour<br />
{<br />
// called when the script is loaded<br />
private void Awake()<br />
{<br />
// this registers a function (OnPlayerChat in this case) to be called<br />
// whenever a player chat event occurs<br />
// for other types of events, check in the modding channel on S2 discord<br />
GameChat.instance.OnChat.AddListener(OnPlayerChat);<br />
}<br />
<br />
// called before the script is unloaded, probably when the server closes/restarts<br />
private void OnDestroy()<br />
{<br />
// presumably important to prevent your script from continuing to respond<br />
// to events after it gets removed/disabled<br />
GameChat.instance.OnChat.RemoveListener(OnPlayerChat);<br />
}<br />
<br />
// user-defined function for handling chat events - the name can be any<br />
// (valid) identifier, only the signature is important<br />
void OnPlayerChat(Player p, string msg)<br />
{<br />
// we are only implementing a single command in this example, but if<br />
// you want to have multiple commands a switch/case statement is probably<br />
// more appropriate<br />
if( msg == "!bal" || msg == "!balance" )<br />
{<br />
// first we grab a list of the players on each team<br />
List<Player> t0 = MonoSingleton<Players>.Get.GetPlayersOfTeam(0);<br />
List<Player> t1 = MonoSingleton<Players>.Get.GetPlayersOfTeam(1);<br />
<br />
// integer division rounds down, so we will only do something if teams<br />
// are unbalanced by more than one player<br />
int hdiff = (t0.Count-t1.Count)/2;<br />
if( hdiff > 0 )<br />
{ // more players on team 0, move half the difference to team 1<br />
for( int i=0; i<hdiff; i++ ) t0[i].props["team"] = 1;<br />
return;<br />
}<br />
else if( hdiff < 0 )<br />
{ // more players on team 1, move half the difference to team 0<br />
for( int i=0; i<-hdiff; i++ ) t1[i].props["team"] = 0;<br />
return;<br />
}<br />
}<br />
}<br />
<br />
}<br />
</syntaxhighlight><br />
<br />
[[Category:Scripting]]</div>ALhttps://wiki.soldat2.com/index.php?title=Main_Page&diff=97Main Page2023-02-02T13:08:39Z<p>AL: </p>
<hr />
<div><strong>Welcome to the Soldat 2 Wiki</strong><br />
<br />
== Contents ==<br />
<br />
* [[Weapons]]<br />
* [[Ranked]]<br />
* [[Movement|Movement Guide]]<br />
* [[:Category:Modding]]<br />
** [[Mapping|Mapping Guide]]<br />
** [[Scripting Introduction]]<br />
** [[Scripting Events]]<br />
** [[Scripting Examples]]<br />
* [[Server Hosting]]<br />
<br />
== Important Links ==<br />
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]<br />
* [https://oczki.pl/s2-players Active Player Dashboard]<br />
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]<br />
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]<br />
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=96User:AL2023-01-24T12:24:21Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server<br />
* <code>UnityEngine.Time.timeScale</code> can be used to change the speed at which the game runs, 1=normal, 2=double speed, 0.5=half speed, etc<br />
* <code>RespawningCommon.KillAllRespawnAll()</code> kill all players<br />
* <code>GetComponent<StandardRespawning>().allowRespawning</code> set to false to control whether players can automatically respawn<br />
* <code>GamesCycle.instance.game.rules</code> the name of the current rules set being used (ie gamemode)</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=95User:AL2023-01-22T08:49:27Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server<br />
* <code>UnityEngine.Time.timeScale</code> can be used to change the speed at which the game runs, 1=normal, 2=double speed, 0.5=half speed, etc<br />
* <code>RespawningCommon.KillAllRespawnAll()</code> kill all players</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=83User:AL2023-01-18T09:40:17Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server<br />
* <code>UnityEngine.Time.timeScale</code> can be used to change the speed at which the game runs, 1=normal, 2=double speed, 0.5=half speed, etc</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=82User:AL2023-01-17T15:34:00Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Math ===<br />
The <code>Teal.Math</code> class contains some potentially useful functions:<br />
<pre><br />
public static bool IsNearlyEqual(float value1, float value2, float epsilon = 0.0001f);<br />
public static Vector2 CloserPosition(Vector2 point, Vector2 a, Vector2 b);<br />
public static bool IsWithin(this int value, int minimum, int maximum);<br />
public static bool IsWithin(this float value, float minimum, float maximum);<br />
public static bool IsValid(this float value);<br />
public static float Normalize(ref Vector2 v);<br />
public static float Normalize(ref Vector3 v);<br />
public static float Angle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p_vector2);<br />
public static float SignedAngle(Vector2 p1, Vector2 p2);<br />
public static Vector3 RotatePointAroundPivot(Vector3 point, Vector3 pivot, Vector3 angles);<br />
public static Vector3 RotateVector(Vector3 vector, float angle);<br />
public static void InitRandom(int seed);<br />
public static int Random(int max);<br />
public static float Random(float max);<br />
public static int RandomRange(int min, int max);<br />
public static float RandomRange(float min, float max);<br />
public static Vector3 GetRandomVector(Vector3 v);<br />
public static Vector2 GetRandomVector(Vector2 v);<br />
public static bool CirclesCollide(Vector3 pos1, Vector3 pos2, float radius1, float radius2);<br />
public static bool LineSegmentsIntersecting(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4);<br />
public static Vector2 LineIntersectionPoint(Vector2 l1s, Vector2 l1e, Vector2 l2s, Vector2 l2e);<br />
public static bool IsPointBetweenLine(Vector2 a, Vector2 b, Vector2 c);<br />
public static bool AreLinesIntersecting(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2, bool shouldIncludeEndPoints);<br />
public static bool AreLinesParallel(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static bool AreLinesSame(Vector2 l1_p1, Vector2 l1_p2, Vector2 l2_p1, Vector2 l2_p2);<br />
public static float ClampRotation(float rotation);<br />
public static Quaternion MirrorRotation(Quaternion q);<br />
public static bool IsStraight(Vector2 p1, Vector2 p2, Vector2 p3, float factor = 0.9f);<br />
public static float GetStraightness(Vector2 p1, Vector2 p2, Vector2 p3);<br />
public static bool IsTurningLeft(Vector2 a, Vector2 b, Vector2 c);<br />
public static Vector2 NearestPointOnLineSegment(Vector2 origin, Vector2 end, Vector2 point);<br />
public static bool IsCountourInteresecting(Vector3[] v);<br />
</pre><br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=81User:AL2023-01-17T15:29:09Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
Can potentially set up a listener for whenever a specific player's health changes: <code>controls.GetComponent<StandardObject>().HealthChanged.AddListener(cb)</code>, where the callback function cb takes a single float as its argument<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=80User:AL2023-01-17T15:05:49Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
* <code>controls.GetComponent<StandardObject>().Master_SetHealth(float hp, Player p = null, NetworkObject unknown = null)</code> set player health, only works if executed on the server<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=79User:AL2023-01-17T14:47:31Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<pre><br />
public Type type;<br />
public string nick;<br />
public ushort id;<br />
public bool rcon;<br />
public int ping;<br />
public bool levelLoaded;<br />
public bool waitingForSpawn;<br />
public SyncedProperties props;<br />
public object userData;<br />
protected float timeOnJoin;<br />
protected float timeOnPing;<br />
public float timeOnDeath;<br />
public float timeOnSpawn;<br />
public Dictionary<string, List<string>> votes = new Dictionary<string, List<string>>();<br />
public bool muted;<br />
public bool IsLocal();<br />
public bool IsBot();<br />
public bool IsRemote();<br />
public float GetPlayTime();<br />
public float GetTimeSinceLastPing();<br />
public float GetTimeSinceDeath();<br />
public float GetTimeSinceRespawn();<br />
public bool IsDead();<br />
public int GetTeam();<br />
public bool IsSpectator();<br />
</pre><br />
<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=78User:AL2023-01-17T14:42:04Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Teal.Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=77User:AL2023-01-17T14:38:32Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. Note that this list is by no means exhaustive.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=76User:AL2023-01-17T14:37:02Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>player.props.Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=75User:AL2023-01-17T14:32:24Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
* <code>controls.GetComponent<StandardObject>().Master_Death()</code> kill the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=74User:AL2023-01-17T14:30:51Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Player ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>Create(string key, object value)</code><br />
<br />
==== Players ====<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
==== Controls ====<br />
The <code>Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=73User:AL2023-01-17T14:29:21Z<p>AL: </p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting.<br />
<br />
=== Messaging ===<br />
* <code>Debug.Log()</code> print to debug console, accepts any number of printable arguments<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Players ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
* The <code>props</code> member is a dictionary that is both readable and writable. Some potentially useful keys are:<br />
** Id<br />
** type<br />
** team<br />
** score<br />
** kills<br />
** deaths<br />
** weapon<br />
** weapon2<br />
It is also possible to add new properties if you want to associate some custom data to players using <code>Create(string key, object value)</code><br />
<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
The <code>Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events. It also allows access to some other classes that affect different aspects of the player.<br />
* <code>controls.GetComponent<GostekJets>().jetsAllowed</code> boolean value, read/writable<br />
* <code>controls.transform.position</code> returns a Vector3 of the current position of the player<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code><br />
* <code>GameCursor.GetWorldPosition()</code> gets the current position of the local player's cursor, unknown how it will work on a server</div>ALhttps://wiki.soldat2.com/index.php?title=User:AL&diff=72User:AL2023-01-17T14:15:20Z<p>AL: Created page with "== Scripting Notes == The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting. === Messaging === * <code>GameChat.ChatOrLog(string message)</code> print a chat message * <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returne..."</p>
<hr />
<div>== Scripting Notes ==<br />
The exact limits of what scripting in Soldat 2 can do is not yet known, but it already looks to far exceed what was possible in Soldat 1. The following is a somewhat random assortment of different ways to affect or read the game state from scripting.<br />
<br />
=== Messaging ===<br />
* <code>GameChat.ChatOrLog(string message)</code> print a chat message<br />
* <code>HUD.Get.Notify(string message, UnityEngine.Color c)</code> text printout similar to flag grabbed/returned text<br />
<br />
=== Players ===<br />
The <code>Teal.Player</code> object is what we manipulate to read or change data related to players.<br />
<br />
The singleton class <code>Teal.Players</code> provides many different ways to retrieve relevant player objects:<br />
<pre><br />
public List<Player> players;<br />
public int PlayersCount;<br />
public Player GetLocalPlayer();<br />
public ushort GetLocalPlayerId();<br />
public Controls GetLocalPlayerControlled();<br />
public Player GetPlayerByID(ushort ID);<br />
public Player GetPlayerByNick(string nick);<br />
public Player GetPlayerByPropertyId(ushort id);<br />
public Controls GetPlayerControlledByID(ushort ID);<br />
public List<Player> GetPlayersOfTeam(int team);<br />
public List<Player> GetPlayersOfTeamExcept(int team, Player player);<br />
public List<Player> GetBots();<br />
public List<Player> GetAlive();<br />
public List<Player> GetAliveBots();<br />
public List<Player> GetAliveHumans();<br />
public List<Player> GetHumans();<br />
public List<Player> GetHumansNonSpectator();<br />
public List<Player> GetHumansOnClient();<br />
public List<Player> GetTeam(int team);<br />
public List<Player> GetAliveTeam(int team);<br />
public List<Player> GetSpecators();<br />
public List<Player> GetPlayersNonSpecators();<br />
</pre><br />
<br />
The <code>Controls</code> class allows querying some properties like whether the player is dead, is human/bot, and some (limited?) input events<br />
<br />
=== Misc ===<br />
* The <code>Teal.RealTime</code> class offers a number of different time measures:<br />
** <code>public static float realtimeSinceStartup;</code><br />
** <code>public static float timeSinceLevelLoad;</code><br />
** <code>public static double SecsSinceStart;</code></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=71Scripting Events2023-01-16T15:51:29Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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><br />
<br />
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.</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=70Scripting Events2023-01-16T15:50:41Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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><br />
<br />
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.</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=69Scripting Events2023-01-16T15:50:23Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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><br />
<br />
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.</div>ALhttps://wiki.soldat2.com/index.php?title=Main_Page&diff=68Main Page2023-01-16T15:44:29Z<p>AL: Add link to scripting events</p>
<hr />
<div><strong>Welcome to the Soldat 2 Wiki</strong><br />
<br />
== Contents ==<br />
* [[Weapons]]<br />
* [[Ranked]]<br />
* [[Movement|Movement Guide]]<br />
* [[Mapping|Mapping Guide]]<br />
* [[Scripting Introduction]]<br />
* [[Scripting Events]]<br />
* [[Server Hosting]]<br />
<br />
== Important Links ==<br />
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]<br />
* [https://oczki.pl/s2-players Active Player Dashboard]<br />
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]<br />
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]<br />
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=67Scripting Events2023-01-16T15:42:25Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=66Scripting Events2023-01-16T15:41:14Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
== Eventor Events ==<br />
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
== Other Events ==<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=65Scripting Events2023-01-16T15:39:58Z<p>AL: </p>
<hr />
<div>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. In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.<br />
<br />
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:<br />
* 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></div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Events&diff=64Scripting Events2023-01-16T15:04:57Z<p>AL: Created page with "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. In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>. The event types that are u..."</p>
<hr />
<div>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. In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.<br />
<br />
The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:<br />
* None<br />
* New_Connection<br />
* Created<br />
* Destroyed<br />
* Died<br />
* Add_Player<br />
* Remove_Player<br />
* Player_Joined<br />
* Player_Assigned<br />
* Player_Left<br />
* Player_Changed_Team<br />
* Player_Unassigned<br />
* Level_Loaded<br />
* Rules_Loaded<br />
* Impacted<br />
* Weapon_Selected<br />
* Trigger<br />
* Match_Waiting<br />
* Match_Warmup<br />
* Match_Started<br />
* Match_Ended<br />
* Hit<br />
* Camera_Target_Changed<br />
* Camera_Created<br />
* Powerup_Started<br />
* Powerup_Ended<br />
* Bullet_Created<br />
* Bot_Assigned<br />
* Flag_Captured<br />
* Flag_Returned<br />
* Flag_Grabbed<br />
* Use_Weapon<br />
* Construct_AddBody<br />
* Construct_RemoveBody<br />
* Properties_Changed<br />
* Item_Dropped<br />
* Item_Picked<br />
* AssignedNetworkId<br />
* Changed_Team<br />
* Request_Spawn<br />
* End_Condition<br />
* Reserved<br />
<br />
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.</div>ALhttps://wiki.soldat2.com/index.php?title=Category:Scripting&diff=63Category:Scripting2023-01-16T12:51:00Z<p>AL: Created page with "Pages related to scripting in Soldat 2"</p>
<hr />
<div>Pages related to scripting in Soldat 2</div>ALhttps://wiki.soldat2.com/index.php?title=Main_Page&diff=62Main Page2023-01-16T12:40:49Z<p>AL: Add link to scripting introduction</p>
<hr />
<div><strong>Welcome to the Soldat 2 Wiki</strong><br />
<br />
== Contents ==<br />
* [[Weapons]]<br />
* [[Ranked]]<br />
* [[Movement|Movement Guide]]<br />
* [[Mapping|Mapping Guide]]<br />
* [[Scripting Introduction]]<br />
* [[Server Hosting]]<br />
<br />
== Important Links ==<br />
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]<br />
* [https://oczki.pl/s2-players Active Player Dashboard]<br />
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]<br />
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]<br />
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=61Scripting Introduction2023-01-16T12:35:46Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
== Scripting Resources ==<br />
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].<br />
<br />
There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.<br />
<br />
Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.<br />
<br />
[[Category:Scripting]]</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=60Scripting Introduction2023-01-16T12:20:11Z<p>AL: </p>
<hr />
<div>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.<br />
<br />
= Scripting Resources =<br />
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].<br />
<br />
There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.<br />
<br />
Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.</div>ALhttps://wiki.soldat2.com/index.php?title=Scripting_Introduction&diff=59Scripting Introduction2023-01-16T11:17:32Z<p>AL: Created page with "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."</p>
<hr />
<div>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.</div>ALhttps://wiki.soldat2.com/index.php?title=Main_Page&diff=58Main Page2023-01-16T10:48:18Z<p>AL: Add link to ranked page</p>
<hr />
<div><strong>Welcome to the Soldat 2 Wiki</strong><br />
<br />
== Contents ==<br />
* [[Weapons]]<br />
* [[Ranked]]<br />
* [[Movement|Movement Guide]]<br />
* [[Mapping|Mapping Guide]]<br />
* [[Server Hosting]]<br />
<br />
== Important Links ==<br />
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]<br />
* [https://oczki.pl/s2-players Active Player Dashboard]<br />
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]<br />
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]<br />
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]</div>AL