Difference between revisions of "Osiris/API/CharacterRemoveFromParty"

From Divinity Engine Wiki
Jump to: navigation, search
(Documented CharacterRemoveFromParty)
 
m
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
* call '''CharacterRemoveFromParty'''(''(CHARACTERGUID)'''''_Character''')
 
* call '''CharacterRemoveFromParty'''(''(CHARACTERGUID)'''''_Character''')
 
===== Description =====
 
===== Description =====
Removes the character '''_Character''' from their [[Osiris/API/AddToParty|party]]. The character will not be added to another party, but will remain a player character if it was one.
+
Deprecated. This is a remnant from DOS1 and should not be used in DOS2.
 +
 
 +
Turning a character into an [[Osiris/API/CharacterMakeNPC|NPC]] automatically removes them from their party. Since all characters assigned to the same [[Osiris/API/CharacterGetReservedUserID|user]] must be in the same party and [[Osiris/API/CharacterAssignToUser|assigning a character to a different user]] automatically changes their party, there is no valid use-case for this API.
 
===== Notes =====
 
===== Notes =====
* This call will not do anything if '''_Character''' is NULL or not in a party.
+
* /
* After removing a player character from a party this way, make sure to add it to another party in the same frame using [[Osiris/API/CharacterAddToParty|CharacterAddToParty]].
 
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/AddToParty|AddToParty]]
 
* [[Osiris/API/AddToParty|AddToParty]]
 
* [[Osiris/API/CharacterAddToParty|CharacterAddToParty]]
 
* [[Osiris/API/CharacterAddToParty|CharacterAddToParty]]
 
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
 
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
 +
* [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]]
 
* [[Osiris/API/CharacterIsPartyMember|CharacterIsPartyMember]]
 
* [[Osiris/API/CharacterIsPartyMember|CharacterIsPartyMember]]
 
* [[Osiris/API/CharacterIsInPartyWith|CharacterIsInPartyWith]]
 
* [[Osiris/API/CharacterIsInPartyWith|CharacterIsInPartyWith]]
Line 19: Line 21:
 
* [[Osiris/API/LeaveParty|LeaveParty]]
 
* [[Osiris/API/LeaveParty|LeaveParty]]
  
[[Category:Osiris Calls]]
+
[[Category:Osiris Calls|CharacterRemoveFromParty]]

Latest revision as of 16:19, 19 December 2017

Full Definition(s)
  • call CharacterRemoveFromParty((CHARACTERGUID)_Character)
Description

Deprecated. This is a remnant from DOS1 and should not be used in DOS2.

Turning a character into an NPC automatically removes them from their party. Since all characters assigned to the same user must be in the same party and assigning a character to a different user automatically changes their party, there is no valid use-case for this API.

Notes
  • /
See Also