Osiris/API/CharacterAddToParty: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(More clarifications about (non-)usage of this call)
(This call should never be used.)
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.
* /
* '''_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]]

Revision as of 09:55, 30 November 2017

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
  • /
See Also
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/CharacterAddToParty&oldid=4466"