Commshare - Revision history

RandomX at 05:33, 1 November 2022

2022-11-01T05:33:26Z

RandomX at 05:32, 1 November 2022

2022-11-01T05:32:08Z

RandomX: No longer an alpha feature. Local image. Minor reformatting.

2022-11-01T05:28:03Z

No longer an alpha feature. Local image. Minor reformatting.

DeinFreund: How to turn on commshare

2018-08-22T09:18:28Z

How to turn on commshare

DeinFreund: add navbox

2018-08-22T09:13:46Z

add navbox

DeinFreund: this page should have more links

2018-08-22T09:12:21Z

this page should have more links

Shaman at 01:25, 22 January 2017

2017-01-22T01:25:59Z

Shaman: /* Privileges */

2017-01-22T01:18:08Z

Privileges

Shaman at 01:16, 22 January 2017

2017-01-22T01:16:17Z

Shaman: Create commshare page

2017-01-18T21:29:08Z

Create commshare page

New page

[[Category:Manual]]

== Overview ==
Commshare (or Command Share) is an alpha feature. Players who engage in Commsharing are assigned to a squad, which functions as if all the members of the squad were one player. Each member assigned to a squad adds their income and units to the squad.

= Overview of modes =
Commshare has three modes of operation:

* All mode
All players are merged at game start (specifically ~166ms into the game). Nobody may unmerge or kick anyone at any time.

* Invite mode (Default)
To merge with another player, you must first both agree to it. The player who invites the other first becomes the 'squad leader' who acts as the representative of the squad. Squad leaders can kick anyone for any reason at any time. They will receive their units back upon getting kicked, however. You may also leave a squad at any time as well. Issuing an invite is simple: Press H then click

* None
No commsharing is allowed. No commshare commands will be responded to.

= Privileges =

All members may accept, decline, or issue invites. Only the squad leader may kick anyone.

@@ Line 43: / Line 43: @@
 !Param!!class="unsortable"|Info!!class="unsortable"|Notes
 |-
-|<syntaxhighlight lang="lua" inline>commshare_invitecount</syntaxhighlight> || # of invites || Get this first, then do a <syntaxhighlight lang="lua" inline>for i=1,commshare_invitecount</syntaxhighlight> loop.
+|<syntaxhighlight lang="lua" inline>commshare_invitecount</syntaxhighlight> || # of invites || Get this first, then do a <syntaxhighlight lang="lua" inline>for i = 1, commshare_invitecount</syntaxhighlight> loop.
 |-
 |<syntaxhighlight lang="lua" inline>"commshare_invite_" .. i .."_id"</syntaxhighlight> || ID of the player who sent the invite ||

@@ Line 33: / Line 33: @@
 |Kick || <var>playerID</var> || Forces <var>playerID</var> to unmerge, requires teamleader.
 |-
-|Remerge || None || Causes you to remerge if you were disconnected/kicked from game.
+|Remerge || None || Causes you to remerge if you were disconnected or kicked from game.
 |-
 |Unmerge || None || Causes you to unmerge.
 |}
-=== TeamRulesParam: Getting invites ===
+=== Getting invites ===
 Invites are stored in <syntaxhighlight lang="lua" inline>TeamRulesParam</syntaxhighlight> as private data. It is stored as if it were an ordered table.
 {|class="wikitable sortable"

@@ Line 1: / Line 1: @@
 == Overview ==
-Commshare (or Command Share) is an alpha feature. Players who engage in Commsharing are assigned to a squad, which functions as if all the members of the squad were one player. Each member assigned to a squad adds their income and [[units]] to the squad.
+Commshare (or Command Share) allows players to share control of units. Players who engage in Commsharing are assigned to a squad, which functions as if all the members of the squad were one player. Each squad member contributes all income and [[units]] to the squad.
-Enable Commshare by holding '''Tab''' to open the player list, then pressing the <img src="https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/LuaUI/Images/Commshare.png" height='16' alighn="center"/> Commshare Icon to invite a player into your squad or to accept the player's invitation into their squad.
+Enable Commshare by holding {{key press|Tab}} to open the player list, then pressing the <samp>[[File:Commshare.png|x16px|Commshare|link=]] Commshare</samp> icon to invite a player into your squad or to accept a player's invitation to a squad.
-= Overview of modes =
+== Modes ==
 Commshare has three modes of operation:
-* All mode
+== Privileges ==
 All members may accept, decline, or issue invites. Only the squad leader may kick anyone.
-= Developing =
+== Developing ==
-Commands to commshare should be issued using SendLuaRulesMsg with the following string:
+Commands to commshare should be issued using <syntaxhighlight lang="lua" inline>SendLuaRulesMsg</syntaxhighlight> with the following string:
- sharemode <command> <param>
+<syntaxhighlight lang="lua">sharemode <command> <param></syntaxhighlight>
 This is not case sensitive. The following are valid commands:
-{|
+{|class="wikitable sortable"
-!Command:!!Param:!!Purpose:
+!Command!!Param!!class="unsortable"|Purpose
 |-
-|Accept || playerID || Accepts an invite from playerID.
+|Accept || <var>playerID</var> || Accepts an invite from <var>playerID</var>.
 |-
-|Decline || playerID || Declines an invite from playerID.
+|Decline || <var>playerID</var> || Declines an invite from <var>playerID</var>.
 |-
-|Invite || playerID || Issues an invite to playerID.
+|Invite || <var>playerID</var> || Issues an invite to <var>playerID</var>.
 |-
-|Kick || playerID || Forces playerID to unmerge, requires teamleader.
+|Kick || <var>playerID</var> || Forces <var>playerID</var> to unmerge, requires teamleader.
 |-
-|Remerge || None || Causes you to remerge, if you were disconnected/kick from game.
+|Remerge || None || Causes you to remerge if you were disconnected/kicked from game.
 |-
 |Unmerge || None || Causes you to unmerge.
 |}
-== TeamRulesParam: Getting invites ==
+=== TeamRulesParam: Getting invites ===
-Invites are stored in TeamRulesParam as private data. It is stored as if it was an ordered table.
+Invites are stored in <syntaxhighlight lang="lua" inline>TeamRulesParam</syntaxhighlight> as private data. It is stored as if it were an ordered table.
-{|
+{|class="wikitable sortable"
-!Param:!!Info:!!Notes:
+!Param!!class="unsortable"|Info!!class="unsortable"|Notes
 |-
-|commshare_invitecount || # of invites || Get this first, then do a for i=1,commshare_invitecount loop.
+|<syntaxhighlight lang="lua" inline>commshare_invitecount</syntaxhighlight> || # of invites || Get this first, then do a <syntaxhighlight lang="lua" inline>for i=1,commshare_invitecount</syntaxhighlight> loop.
 |-
-|"commshare_invite_" .. i .."_id" || ID of the player who sent the invite ||
+|<syntaxhighlight lang="lua" inline>"commshare_invite_" .. i .."_id"</syntaxhighlight> || ID of the player who sent the invite ||
 |-
-|"commshare_invite_" .. i .."_timeleft" || Time remaining on this invite || You must check if this is different than last second's count to see if it's dead.
+|<syntaxhighlight lang="lua" inline>"commshare_invite_" .. i .."_timeleft"</syntaxhighlight> || Time remaining on this invite || You must check if this is different than last second's count to see if it's dead.
 |}
 {{Navbox manual}}

← Older revision		Revision as of 09:13, 22 August 2018
Line 52:		Line 52:
	\|"commshare_invite_" .. i .."_timeleft" \|\| Time remaining on this invite \|\| You must check if this is different than last second's count to see if it's dead.		\|"commshare_invite_" .. i .."_timeleft" \|\| Time remaining on this invite \|\| You must check if this is different than last second's count to see if it's dead.
	\|}		\|}
		+
		+	{{Navbox manual}}

@@ Line 18: / Line 18: @@
 = Privileges =
-All members may accept, decline, or issue invites. Only the squad leader may kick anyone. It should be noted:
+All members may accept, decline, or issue invites. Only the squad leader may kick anyone.
 = Developing =

@@ Line 11: / Line 11: @@
 * Invite mode (Default)
-To merge with another player, you must first both agree to it. The player who invites the other first becomes the 'squad leader' who acts as the representative of the squad. Squad leaders can kick anyone for any reason at any time. They will receive their units back upon getting kicked, however. You may also leave a squad at any time as well. Issuing an invite is simple: Press H then click
+To merge with another player, you must first both agree to it. The player who invites the other first becomes the 'squad leader' who acts as the representative of the squad. Squad leaders can kick anyone for any reason at any time. They will receive their units back upon getting kicked, however. You may also leave a squad at any time as well. Issuing an invite is simple: Press H then click on the half teal/half green commander.
 * None

← Older revision		Revision as of 01:16, 22 January 2017
Line 18:		Line 18:
	= Privileges =		= Privileges =

−	All members may accept, decline, or issue invites. Only the squad leader may kick anyone.	+	All members may accept, decline, or issue invites. Only the squad leader may kick anyone. It should be noted:
		+	* Inviting a non-leader will only merge that person into your squad.
		+	* Inviting a leader will merge the two squads together.
		+
		+	= Developing =
		+
		+	Commands to commshare should be issued using SendLuaRulesMsg with the following string:
		+	sharemode <command> <param>
		+	This is not case sensitive. The following are valid commands:
		+	{\|
		+	!Command:!!Param:!!Purpose:
		+	\|-
		+	\|Accept \|\| playerID \|\| Accepts an invite from playerID.
		+	\|-
		+	\|Decline \|\| playerID \|\| Declines an invite from playerID.
		+	\|-
		+	\|Invite \|\| playerID \|\| Issues an invite to playerID.
		+	\|-
		+	\|Kick \|\| playerID \|\| Forces playerID to unmerge, requires teamleader.
		+	\|-
		+	\|Remerge \|\| None \|\| Causes you to remerge, if you were disconnected/kick from game.
		+	\|-
		+	\|Unmerge \|\| None \|\| Causes you to unmerge.
		+	\|}
		+
		+	== TeamRulesParam: Getting invites ==
		+	Invites are stored in TeamRulesParam as private data. It is stored as if it was an ordered table.
		+	{\|
		+	!Param:!!Info:!!Notes:
		+	\|-
		+	\|commshare_invitecount \|\| # of invites \|\| Get this first, then do a for i=1,commshare_invitecount loop.
		+	\|-
		+	\|"commshare_invite_" .. i .."_id" \|\| ID of the player who sent the invite \|\|
		+	\|-
		+	\|"commshare_invite_" .. i .."_timeleft" \|\| Time remaining on this invite \|\| You must check if this is different than last second's count to see if it's dead.
		+	\|}