User Tools

Site Tools


change_player

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
change_player [2021/12/16 12:26] – created justinchange_player [2021/12/16 19:12] (current) justin
Line 2: Line 2:
 ---- ----
  
-Permanently removes the specified [[entity]] from the [[map]].+Swaps out the current [[player character]] for another [[character]]. The other [[character]] can be provided as a [[add_party_member|party member]] or an [[NPC]] that exists within the current [[map]].
  
 ====Signature:==== ====Signature:====
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|character|The [[entity]] to remove from the [[map]].|[[Entity]]|Yes|+|character|The [[character]] to swap the current [[player character]] with.|[[Entity]]|Yes|
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
-change_player(entity["key_01"]);+change_player(party.member["Sarah"]);
 </code> </code>
-//Results:// The [[entity]] with an ID of "key_01is permanently removed from the [[map]].+//Results:// The party member with the ID of "Sarahwill now be the main [[player character]].
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Remove Entity** function to remove [[character|characters]] that have exited during a cutscene or as a way for the player to "collect" [[object|objects]] from the scene (i.e. [[item]] pickups).+Use the **Change Player** function from a [[dialogue]] or custom [[widget]] to allow the player to switch between members of their party.
 </WRAP> </WRAP>
  
change_player.1639686386.txt.gz · Last modified: 2021/12/16 12:26 by justin