Difference between revisions of "Osiris/API/CharacterRecruitCharacter"
From Divinity Engine Wiki
m |
m (Clarify that summons and party followers also join the new party) |
||
| Line 2: | Line 2: | ||
* call '''CharacterRecruitCharacter'''('''''[in]'''(CHARACTERGUID)'''''_TargetCharacter''','''''[in]'''(CHARACTERGUID)'''''_OwnerCharacter''') | * call '''CharacterRecruitCharacter'''('''''[in]'''(CHARACTERGUID)'''''_TargetCharacter''','''''[in]'''(CHARACTERGUID)'''''_OwnerCharacter''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Turns NPC '''_TargetCharacter''' into a player-controlled character | + | Turns NPC '''_TargetCharacter''' into a player-controlled character. The character will be assigned to the [[Osiris/API/CharacterGetReservedUserID|user]] that hosts the game, and hence also to their [[Osiris/API/AddToParty|party]]). It will appear in the portrait list after '''_OwnerCharacter'''. |
===== Notes ===== | ===== Notes ===== | ||
* If '''_TargetCharacter''' is already a player-controlled character, this call does nothing. In particular, in that case it will not change the party assignment of '''_TargetCharacter'''. | * If '''_TargetCharacter''' is already a player-controlled character, this call does nothing. In particular, in that case it will not change the party assignment of '''_TargetCharacter'''. | ||
| + | * Any [[Osiris/API/CharacterIsSummon|summons]] and [[Osiris/API/CharacterAddToParty|party followers]] of '''_TargetCharacter''' will also move to '''_TargetCharacter''''s new party. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterAddToParty|CharacterAddToParty]] | * [[Osiris/API/CharacterAddToParty|CharacterAddToParty]] | ||
Revision as of 22:47, 28 November 2017
Full Definition(s)
- call CharacterRecruitCharacter([in](CHARACTERGUID)_TargetCharacter,[in](CHARACTERGUID)_OwnerCharacter)
Description
Turns NPC _TargetCharacter into a player-controlled character. The character will be assigned to the user that hosts the game, and hence also to their party). It will appear in the portrait list after _OwnerCharacter.
Notes
- If _TargetCharacter is already a player-controlled character, this call does nothing. In particular, in that case it will not change the party assignment of _TargetCharacter.
- Any summons and party followers of _TargetCharacter will also move to _TargetCharacter's new party.
