Difference between revisions of "Osiris/API/AddToParty"
From Divinity Engine Wiki
m |
m |
||
| (7 intermediate revisions by the same user not shown) | |||
| 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 | + | * A party is a group of all [[Osiris/API/CharacterIsPlayer|player-controlled characters]] from one or more [[Osiris/API/CharacterGetReservedUserID|users]], along with these characters' totems (and in Game Master mode, also characters possessed by the game master). 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. | ||
| + | * Never add NPCs to a party, as many code paths do not support that situation (it is not possible with this API, but it is possible with another one). | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterAddToParty|CharacterAddToParty]] | * [[Osiris/API/CharacterAddToParty|CharacterAddToParty]] | ||
| Line 13: | Line 14: | ||
* [[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]] | ||
| Line 19: | Line 21: | ||
* [[Osiris/API/LeaveParty|LeaveParty]] | * [[Osiris/API/LeaveParty|LeaveParty]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|AddToParty]] |
Latest revision as of 08:43, 18 January 2019
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 player-controlled characters from one or more users, along with these characters' totems (and in Game Master mode, also characters possessed by the game master). 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.
- Never add NPCs to a party, as many code paths do not support that situation (it is not possible with this API, but it is possible with another one).
