Difference between revisions of "Osiris/API/CharacterAddToPlayerCharacter"
From Divinity Engine Wiki
m |
|||
| Line 2: | Line 2: | ||
* call '''CharacterAddToPlayerCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_Owner''') | * call '''CharacterAddToPlayerCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_Owner''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Turns '''_Character''' into a ''party follower'' of [[Osiris/API/CharacterIsPlayer|player-controlled]] character '''_Character'''. | + | Turns '''_Character''' into a [[Party_Followers|''party follower'']] of [[Osiris/API/CharacterIsPlayer|player-controlled]] character '''_Character'''. |
| − | A party follower of a player character can be identified by the fact that a small version of their icon becomes attached to the bottom right of the icon of the player they follow in the top left of the screen. The controlling player can select the party follower, move them around and fight with them, but not perform other interactions such as using items or participating in dialogs. In that sense, they are very similar to summons. | + | A [[Party_Followers|party follower]] of a player character can be identified by the fact that a small version of their icon becomes attached to the bottom right of the icon of the player they follow in the top left of the screen. The controlling player can select the party follower, move them around and fight with them, but not perform other interactions such as using items or participating in dialogs. In that sense, they are very similar to summons. |
| − | In theory, it also possible to create party followers for [[Osiris/API/CharacterAddToParty|NPCs that are in a party]], but this is not used in the main DOS2 campaign and hence untested. | + | In theory, it also possible to create [[Party_Followers|party followers]] for [[Osiris/API/CharacterAddToParty|NPCs that are in a party]], but this is not used in the main DOS2 campaign and hence untested. |
===== Notes ===== | ===== Notes ===== | ||
* This call fails if either '''_Character''' or '''_Owner''' is '''NULL''', or if '''_Owner''' is not in a [[Osiris/API/CharacterAddToParty|party]]. | * This call fails if either '''_Character''' or '''_Owner''' is '''NULL''', or if '''_Owner''' is not in a [[Osiris/API/CharacterAddToParty|party]]. | ||
Revision as of 16:06, 29 November 2017
Full Definition(s)
- call CharacterAddToPlayerCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_Owner)
Description
Turns _Character into a party follower of player-controlled character _Character.
A party follower of a player character can be identified by the fact that a small version of their icon becomes attached to the bottom right of the icon of the player they follow in the top left of the screen. The controlling player can select the party follower, move them around and fight with them, but not perform other interactions such as using items or participating in dialogs. In that sense, they are very similar to summons.
In theory, it also possible to create party followers for NPCs that are in a party, but this is not used in the main DOS2 campaign and hence untested.
Notes
- This call fails if either _Character or _Owner is NULL, or if _Owner is not in a party.
- As long as _Character is a party follower of a player character, CharacterIsPlayer will return 1 for this character.
