Game (functions)/Team Management: Difference between revisions

From PMDOWiki
Imbion (talk | contribs)
Created page with " == GAME:GetTeamLeaderIndex == Returns the index of the currently player controlled entity in the party. === Returns === Index of the currently player controlled entity in the party. == GAME:SetTeamLeaderIndex(System.Int32) == Sets the leader to the chosen index within the party. === Arguments === * <code>idx</code>: The index of the team member within the team. == GAME:SetCanSwitch(System.Boolean) == Prevents or allows the switching of leaders for the save..."
 
Imbion (talk | contribs)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:


== GAME:GetTeamLeaderIndex ==
== GetTeamLeaderIndex ==
 


Returns the index of the currently player controlled entity in the party.
Returns the index of the currently player controlled entity in the party.


=== Returns ===
=== Returns ===
Line 10: Line 8:
Index of the currently player controlled entity in the party.
Index of the currently player controlled entity in the party.


== GAME:SetTeamLeaderIndex(System.Int32) ==
== SetTeamLeaderIndex ==
 
 
Sets the leader to the chosen index within the party.


Sets the leader to the chosen index within the party. {{FuncUsage|nmspace=GAME|nm=SetTeamLeaderIndex|args=idx}}


=== Arguments ===
=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=idx
|type=Integer
|techt=System.Int32
|purp=The index of the team member within the team.
}}
|}


* <code>idx</code>: The index of the team member within the team.
== SetCanSwitch ==


== GAME:SetCanSwitch(System.Boolean) ==
Prevents or allows the switching of leaders for the save file. {{FuncUsage|nmspace=GAME|nm=SetCanSwitch|args=flag}}


=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=flag
|type=Boolean
|techt=System.Boolean
|purp=Set to true to allow switching, set to false to prevent it.
}}
|}


Prevents or allows the switching of leaders for the save file.
== SetCanRecruit ==


Prevents or allows the joining of recruits for the save file. {{FuncUsage|nmspace=GAME|nm=SetCanRecruit|args=flag}}


=== Arguments ===
=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=flag
|type=Boolean
|techt=System.Boolean
|purp=Set to true to allow recruiting, set to false to prevent it.
}}
|}


* <code>canSwitch</code>: Set to true to allow switching, set to false to prevent it.
== SetTeamName ==


== GAME:SetCanRecruit(System.Boolean) ==
Sets the name of the player's team. {{FuncUsage|nmspace=GAME|nm=SetTeamName|args=name}}
 
 
Prevents or allows the joining of recruits for the save file.


=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=name
|type=String
|techt=System.String
|purp=The new team name.
}}
|}


=== Arguments ===
== GetTeamName ==


* <code>canRecruit</code>: Set to true to allow recruit joins, set to false to prevent it.
Gets the name of the player's team. Returns the name of the team.

Latest revision as of 22:19, 17 January 2026

GetTeamLeaderIndex

Returns the index of the currently player controlled entity in the party.

Returns

Index of the currently player controlled entity in the party.

SetTeamLeaderIndex

Sets the leader to the chosen index within the party. Argument order is GAME:SetTeamLeaderIndex(idx).

Arguments

Name Type Technical Type Purpose
idx Integer System.Int32 The index of the team member within the team.

SetCanSwitch

Prevents or allows the switching of leaders for the save file. Argument order is GAME:SetCanSwitch(flag).

Arguments

Name Type Technical Type Purpose
flag Boolean System.Boolean Set to true to allow switching, set to false to prevent it.

SetCanRecruit

Prevents or allows the joining of recruits for the save file. Argument order is GAME:SetCanRecruit(flag).

Arguments

Name Type Technical Type Purpose
flag Boolean System.Boolean Set to true to allow recruiting, set to false to prevent it.

SetTeamName

Sets the name of the player's team. Argument order is GAME:SetTeamName(name).

Arguments

Name Type Technical Type Purpose
name String System.String The new team name.

GetTeamName

Gets the name of the player's team. Returns the name of the team.