Difference between revisions of "Osiris/API/CharacterAddToParty"
From Divinity Engine Wiki
(Mention that this call is normally never needed.) |
(Fixed parameter types) |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * call '''CharacterAddToParty'''(''( | + | * call '''CharacterAddToParty'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID)'''''_PartyCharacter''') |
===== Description ===== | ===== Description ===== | ||
Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty|party]]. | Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty|party]]. | ||
| Line 9: | Line 9: | ||
* '''_Character''' must be global. | * '''_Character''' must be global. | ||
* The difference with [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons). | * The difference with [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons). | ||
| − | ** Adding | + | ** Adding NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions. |
** The only scenario in which this call is useful, and indeed mandatory, is if you remove a [[Osiris/API/CharacterIsPlayer|player-controlled character]] from a party using [[Osiris/API/CharacterRemoveFromParty|CharacterRemoveFromParty]] first. You then must add it to a new party again in the same frame, or many things may go wrong (the engine assumes player characters are always in a party). | ** The only scenario in which this call is useful, and indeed mandatory, is if you remove a [[Osiris/API/CharacterIsPlayer|player-controlled character]] from a party using [[Osiris/API/CharacterRemoveFromParty|CharacterRemoveFromParty]] first. You then must add it to a new party again in the same frame, or many things may go wrong (the engine assumes player characters are always in a party). | ||
===== See Also ===== | ===== See Also ===== | ||
Revision as of 14:28, 29 November 2017
Full Definition(s)
- call CharacterAddToParty((CHARACTERGUID)_Character, (CHARACTERGUID)_PartyCharacter)
Description
Adds the character _Character to _PartyCharacter's party.
Normally, you should never use need nor use this call.
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.
- The difference with CharacterRecruitCharacter is that this call does not turn _Character into a player character (although _Character can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).
- Adding NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.
- The only scenario in which this call is useful, and indeed mandatory, is if you remove a player-controlled character from a party using CharacterRemoveFromParty first. You then must add it to a new party again in the same frame, or many things may go wrong (the engine assumes player characters are always in a party).
