Difference between revisions of "Osiris/API/CharacterRecruitCharacter"
From Divinity Engine Wiki
m |
m (Explain how CharacterRecruitCharacter behaves in case _TargetCharacter is already a player character, and explicitly mention what it does regarding parties.) |
||
| 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. The character will be assigned to the user that hosts the game, and will appear in the portrait list after '''_OwnerCharacter'''. | + | 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 their [[Osiris/API/AddToParty|party]]), and will appear in the portrait list after '''_OwnerCharacter'''. |
===== Notes ===== | ===== Notes ===== | ||
| − | * | + | * If '''_TargetCharacter''' is already a player-controlled character, this call does nothing; in particular, it will not change the party assignment of '''_TargetCharacter'''). |
===== See Also ===== | ===== See Also ===== | ||
| + | * [[Osiris/API/CharacterAddToParty|CharacterAddToParty]] | ||
* [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]] | * [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]] | ||
* [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]] | * [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]] | ||
Revision as of 20:44, 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 their party), and will appear in the portrait list after _OwnerCharacter.
Notes
- If _TargetCharacter is already a player-controlled character, this call does nothing; in particular, it will not change the party assignment of _TargetCharacter).
