Difference between revisions of "Osiris/API/CharacterAddToParty"

From Divinity Engine Wiki
Jump to: navigation, search
(More clarifications about (non-)usage of this call)
(Mention alternatives to use)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
* call '''CharacterAddToParty'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID)'''''_PartyCharacter''')
 
* call '''CharacterAddToParty'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID)'''''_PartyCharacter''')
 
===== Description =====
 
===== Description =====
−
Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty|party]].
+
Deprecated. This is a remnant from DOS1 and should not be used in DOS2.
 +
 
 +
Turning a character into a [[Osiris/API/CharacterRecruitCharacter|player]] or [[Osiris/API/CharacterAssignToUser|assigning it to a user]] automatically adds it to the correct party. Since all characters of a single [[Osiris/API/CharacterGetReservedUserID|user]] must be in the same party and since all characters in a party must be [[Osiris/API/CharacterIsPlayer|player-controlled]], there is no valid use case to explicitly assign a character to a party.
 
===== Notes =====
 
===== Notes =====
−
* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.
+
* Use [[Osiris/API/AddToParty|AddToParty]] instead to assign all characters controlled by a particular user to a different party, [[Osiris/API/LeaveParty|LeaveParty]] to put all of those characters into a new party, or [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]] to assign a character to a different user (and hence also their, potentially different, party).
−
* '''_Character''' must be global.
 
−
* Since characters are automatically added to a party when they get [[Osiris/API/CharacterAssignToUser|assigned to a user]] or [[Osiris/API/CharacterRecruitCharacter|recruited]]/[[Osiris/API/CharacterMakePlayer|made a player]], normally you should never use need nor use this call.
 
−
** This call should only be used to add [[Osiris/API/CharacterIsPlayer|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames|frame]] as the one in which the character was removed.
 
−
** Use [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).
 
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/AddToParty|AddToParty]]
 
* [[Osiris/API/AddToParty|AddToParty]]
Line 23: Line 21:
 
* [[Osiris/API/LeaveParty|LeaveParty]]
 
* [[Osiris/API/LeaveParty|LeaveParty]]
  
−
[[Category:Osiris Calls]]
+
[[Category:Osiris Calls|CharacterAddToParty]]

Latest revision as of 07:22, 12 April 2018

Full Definition(s)
  • call CharacterAddToParty((CHARACTERGUID)_Character, (CHARACTERGUID)_PartyCharacter)
Description

Deprecated. This is a remnant from DOS1 and should not be used in DOS2.

Turning a character into a player or assigning it to a user automatically adds it to the correct party. Since all characters of a single user must be in the same party and since all characters in a party must be player-controlled, there is no valid use case to explicitly assign a character to a party.

Notes
  • Use AddToParty instead to assign all characters controlled by a particular user to a different party, LeaveParty to put all of those characters into a new party, or CharacterAssignToUser to assign a character to a different user (and hence also their, potentially different, party).
See Also
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/CharacterAddToParty&oldid=5887"