Difference between revisions of "Osiris/API/CharacterAddToParty"
From Divinity Engine Wiki
(Clarified that this is no substitute for CharacterRecruitCharacter, and updated usage notes) |
(Mention alternatives to use) |
||
| (4 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 ===== | ||
| − | + | 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 ===== | ||
| − | * | + | * 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). |
| − | |||
| − | |||
| − | |||
===== 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]] | ||
| 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).
