Game (functions)/Guest Management: Difference between revisions

From PMDOWiki
Imbion (talk | contribs)
3,593 edits
Created page with "== GAME:GetPlayerGuestCount == Gets the number of guests currently in the player's party. === Returns === The number of guests == GAME:GetPlayerGuestTable == Return the guests as a LuaTable === Returns === A Lua Table of Characters == GAME:GetPlayerGuestMember(System.Int32) == Gets the character at the specified index within the player's guests. === Arguments === * <code>index</code>: The specified index === Returns === The team member retrieved == GA..."
 
Imbion (talk | contribs)
3,593 edits
No edit summary
 
Line 1: Line 1:
== GAME:GetPlayerGuestCount ==
== GetPlayerGuestCount ==


Returns the number of guests currently in the player's party.


Gets the number of guests currently in the player's party.
== GetPlayerGuestTable ==


Returns the guests as a LuaTable.


=== Returns ===
== GetPlayerGuestMember ==
 
The number of guests
 
== GAME:GetPlayerGuestTable ==
 
 
Return the guests as a LuaTable
 
 
=== Returns ===
 
A Lua Table of Characters
 
== GAME:GetPlayerGuestMember(System.Int32) ==
 
 
Gets the character at the specified index within the player's guests.


Returns the character at the specified index within the player's guests.{{FuncUsage|nmspace=GAME|nm=GetPlayerGuestMember|args=index}}


=== Arguments ===
=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=index
|type=Integer
|techt=System.Int32
|purp=The specified index
}}
|}


* <code>index</code>: The specified index
== AddPlayerGuest ==
 
=== Returns ===
 
The team member retrieved
 
== GAME:AddPlayerGuest(RogueEssence.Dungeon.Character) ==
 
 
Adds a character to the player's guests.
 


Adds a character to the player's guests. {{FuncUsage|nmspace=GAME|nm=AddPlayerGuest|args=chara}}
=== Arguments ===
=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=chara
|type=Dungeon Character
|techt=RogueEssence.Dungeon.Character
|purp=The character to add.
}}
|}


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


Removes the character from the team's guests, placing its item back in the inventory.{{FuncUsage|nmspace=GAME|nm=RemovePlayerGuest|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 guests.
}}

Latest revision as of 22:30, 17 January 2026

GetPlayerGuestCount

Returns the number of guests currently in the player's party.

GetPlayerGuestTable

Returns the guests as a LuaTable.

GetPlayerGuestMember

Returns the character at the specified index within the player's guests.Argument order is GAME:GetPlayerGuestMember(index).

Arguments

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

AddPlayerGuest

Adds a character to the player's guests. Argument order is GAME:AddPlayerGuest(chara).

Arguments

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

RemovePlayerGuest

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

Arguments

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