Difference between revisions of "Osiris/API/CharacterAddToParty"
From Divinity Engine Wiki
m |
(More clarifications about (non-)usage of this call) |
||
| Line 3: | Line 3: | ||
===== Description ===== | ===== Description ===== | ||
Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty|party]]. | Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty|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. | * 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. | * '''_Character''' must be global. | ||
| − | * This | + | * 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. |
| − | * Use [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time). | + | ** 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]] | ||
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]] | * [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]] | ||
| + | * [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]] | ||
* [[Osiris/API/CharacterIsPartyMember|CharacterIsPartyMember]] | * [[Osiris/API/CharacterIsPartyMember|CharacterIsPartyMember]] | ||
* [[Osiris/API/CharacterIsInPartyWith|CharacterIsInPartyWith]] | * [[Osiris/API/CharacterIsInPartyWith|CharacterIsInPartyWith]] | ||
Revision as of 23:03, 29 November 2017
Full Definition(s)
- call CharacterAddToParty((CHARACTERGUID)_Character, (CHARACTERGUID)_PartyCharacter)
Description
Adds the character _Character to _PartyCharacter's party.
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 assigned to a user or recruited/made a player, normally you should never use need nor use this call.
- This call should only be used to add player-controlled characters to a new party after they have been removed from one with CharacterRemoveFromParty. This must be done in the same frame as the one in which the character was removed.
- Use CharacterRecruitCharacter instead to recruit NPCs into a party (and make them a player-controlled character at the same time).
