Game (functions)/Party Management: Difference between revisions

From PMDOWiki
Newer edit →
Imbion (talk | contribs)
3,593 edits
Created page with "== GAME:GetPlayerPartyCount == Returns the player party count. Does not include guests. === Returns === The count of players == GAME:GetPlayerPartyTable == Return the party as a LuaTable. Does not include guests. === Returns === A Lua Table of Characters == GAME:GetPlayerPartyMember(System.Int32) == Gets the character at the specified index within the player's team. === Arguments === * <code>index</code>: The specified index === Returns === The team..."
 
Imbion (talk | contribs)
3,593 edits
No edit summary
Line 1: Line 1:
== GAME:GetPlayerPartyCount ==
== GetPlayerPartyCount ==
 


Returns the player party count.  Does not include guests.
Returns the player party count.  Does not include guests.


 
== GetPlayerPartyTable ==
=== Returns ===
 
The count of players
 
== GAME:GetPlayerPartyTable ==
 


Return the party as a LuaTable.  Does not include guests.
Return the party as a LuaTable.  Does not include guests.


== GetPlayerPartyMember ==


=== Returns ===
Gets the character at the specified index within the player's team. {{FuncUsage|nmspace=GAME|nm=GetPlayerPartyMember|args=index}}
 
A Lua Table of Characters
 
== GAME:GetPlayerPartyMember(System.Int32) ==
 
 
Gets the character at the specified index within the player's team.
 


=== Arguments ===
=== Arguments ===
 
{| class="wikitable"
* <code>index</code>: The specified index
{{ArgHeader}}
{{ArgRow
|name=index
|type=Integer
|techt=System.Int32
|purp=The specified index
}}
|}


=== Returns ===
=== Returns ===
Line 33: Line 26:
The team member retrieved.
The team member retrieved.


 
== AddPlayerTeam ==
== GAME:AddPlayerTeam(RogueEssence.Dungeon.Character) ==
 


Adds a character to the player's team.
Adds a character to the player's team.


=== Arguments ===
=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=character
|type=Dungeon Character
|techt=RogueEssence.Dungeon.Character
|purp=The character to add.
}}
|}


* <code>character</code>: The character to add.
== RemovePlayerTeam ==
 
== GAME:RemovePlayerTeam(System.Int32) ==
 
 
Removes the character from the team, placing its item back in the inventory.


Removes the character from the team, placing its item back in the inventory.{{FuncUsage|nmspace=GAME|nm=RemovePartyMember|args=index}}


=== Arguments ===
=== Arguments ===
 
{| class="wikitable"
* <code>slot</code>: The slot of the player to remove.
{{ArgHeader}}
{{ArgRow
|name=index
|type=Integer
|techt=System.Int32
|purp=The index of the character to remove from the team.
}}
|}

Revision as of 22:22, 17 January 2026

GetPlayerPartyCount

Returns the player party count. Does not include guests.

GetPlayerPartyTable

Return the party as a LuaTable. Does not include guests.

GetPlayerPartyMember

Gets the character at the specified index within the player's team. Argument order is GAME:GetPlayerPartyMember(index).

Arguments

Name Type Technical Type Purpose
index Integer System.Int32 The specified index

Returns

The team member retrieved.

AddPlayerTeam

Adds a character to the player's team.

Arguments

Name Type Technical Type Purpose
character Dungeon Character RogueEssence.Dungeon.Character The character to add.

RemovePlayerTeam

Removes the character from the team, placing its item back in the inventory.Argument order is GAME:RemovePartyMember(index).

Arguments

Name Type Technical Type Purpose
index Integer System.Int32 The index of the character to remove from the team.
Retrieved from "https://wiki.pmdo.pmdcollab.org/wiki/index.php?title=Game_(functions)/Party_Management&oldid=6416"