Difference between revisions of "Osiris/API/AddToParty"
From Divinity Engine Wiki
m |
(expand party definition, and link CharacterMakeNPC because turning a player character back into an NPC removes it from its current party) |
||
| Line 4: | Line 4: | ||
Adds the characters controlled by the [[Osiris/API/CharacterGetReservedUserID|user]] with User ID '''_Source''' to the party to which the user with User ID '''_Target''' belongs. | Adds the characters controlled by the [[Osiris/API/CharacterGetReservedUserID|user]] with User ID '''_Source''' to the party to which the user with User ID '''_Target''' belongs. | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * A party is a group of all characters controlled by one or more [[Osiris/API/CharacterGetReservedUserID|users]]. By default, all users are in the same party. Players can split parties by right-clicking on a character controlled by another user and selecting "Kick from party". From script, you can create multiple parties using some of the APIs mentioned below. | + | * A party is a group of all characters controlled by one or more [[Osiris/API/CharacterGetReservedUserID|users]], along with these characters' [[Osiris/API/CharacterAddToPlayerCharacter|party followers]], [[Osiris/API/CharacterIsSummon|summons]], and optionally (global) NPCs added to the party through [[Osiris/API/CharacterAddToParty|script]]. By default, all users are in the same party. Players can split parties by right-clicking on a character controlled by another user and selecting "Kick from party". From script, you can create multiple parties using some of the APIs mentioned below. |
* All characters from a single user are always in the same party. | * All characters from a single user are always in the same party. | ||
===== See Also ===== | ===== See Also ===== | ||
| Line 13: | Line 13: | ||
* [[Osiris/API/CharacterJoinedParty|CharacterJoinedParty]] | * [[Osiris/API/CharacterJoinedParty|CharacterJoinedParty]] | ||
* [[Osiris/API/CharacterLeftParty|CharacterLeftParty]] | * [[Osiris/API/CharacterLeftParty|CharacterLeftParty]] | ||
| + | * [[Osiris/API/CharacterMakeNPC|CharacterMakeNPC]] | ||
* [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] | * [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] | ||
* [[Osiris/API/CharacterRemoveFromParty|CharacterRemoveFromParty]] | * [[Osiris/API/CharacterRemoveFromParty|CharacterRemoveFromParty]] | ||
Revision as of 22:03, 28 November 2017
Full Definition(s)
- call AddToParty((INTEGER)_Source, (INTEGER)_Target)
Description
Adds the characters controlled by the user with User ID _Source to the party to which the user with User ID _Target belongs.
Notes
- A party is a group of all characters controlled by one or more users, along with these characters' party followers, summons, and optionally (global) NPCs added to the party through script. By default, all users are in the same party. Players can split parties by right-clicking on a character controlled by another user and selecting "Kick from party". From script, you can create multiple parties using some of the APIs mentioned below.
- All characters from a single user are always in the same party.
