Game (functions)/Assembly Management: Difference between revisions

From PMDOWiki
Imbion (talk | contribs)
Created page with "== GAME:GetPlayerAssemblyCount == Gets the number of characters currently in the player's assembly. === Returns === The number of characters == GAME:GetPlayerAssemblyTable == Return the assembly as a LuaTable === Returns === A Lua Table of Characters == GAME:GetPlayerAssemblyMember(System.Int32) == Gets the character at the specified index within the player's assembly. === Arguments === * <code>index</code>: The specified index === Returns === The asse..."
 
Imbion (talk | contribs)
No edit summary
 
Line 1: Line 1:
== GAME:GetPlayerAssemblyCount ==
== GetPlayerAssemblyCount ==


Returns the number of characters currently in the player's assembly.


Gets the number of characters currently in the player's assembly.
== GetPlayerAssemblyTable ==


Returns the assembly as a LuaTable.


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


Returns the character at the specified index within the player's assembly.{{FuncUsage|nmspace=GAME|nm=GetPlayerAssemblyMember|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
== AddPlayerAssembly ==
 
=== Returns ===
 
The assembly member retrieved.
 
== GAME:AddPlayerAssembly(RogueEssence.Dungeon.Character) ==
 
 
Adds a character to the player's assembly.
 


Adds a character to the player's assembly. {{FuncUsage|nmspace=GAME|nm=AddPlayerAssembly|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.
== RemovePlayerAssembly ==
 
== GAME:RemovePlayerAssembly(System.Int32) ==
 


Removes the character from the assembly, placing its item back in the inventory.


Removes the character from the assembly, placing its item back in the inventory. {{FuncUsage|nmspace=GAME|nm=RemovePlayerAssembly|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 assembly.
}}

Latest revision as of 22:26, 17 January 2026

GetPlayerAssemblyCount

Returns the number of characters currently in the player's assembly.

GetPlayerAssemblyTable

Returns the assembly as a LuaTable.

GetPlayerAssemblyMember

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

Arguments

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

AddPlayerAssembly

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

Arguments

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

RemovePlayerAssembly

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

Arguments

Name Type Technical Type Purpose
index Integer System.Int32 The index of the character to remove from the assembly.