Difference between revisions of "Osiris/API/LeaveCombat"

From Divinity Engine Wiki
Jump to: navigation, search
(Osiris Core APIs)
 
m
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
Makes '''_Target''' leave the combat it's currently involved it. Should not be called if '''_Target''' is currently not in combat.
 
Makes '''_Target''' leave the combat it's currently involved it. Should not be called if '''_Target''' is currently not in combat.
 
===== Notes =====
 
===== Notes =====
* Unless you first teleported '''_Target''' away to a safe location, it's quite likely that it will rejoin the same combat during the next frame. If you wish to prevent it from rejoining any further combat, call '''SetCanJoinCombat''' instead (but be careful to restore it again later in case this is done for a player).
+
* Unless you first teleported '''_Target''' away to a safe location, it's quite likely that it will rejoin the same combat during the next frame. If you wish to prevent it from rejoining any further combat, call [[Osiris/API/SetCanJoinCombat|SetCanJoinCombat]] instead (but be careful to restore it again later in case this is done for a player).
 
===== See Also =====
 
===== See Also =====
* [[Osiris/API/ObjectEnteredCombat]]
+
* [[Osiris/API/ObjectEnteredCombat|ObjectEnteredCombat]]
* [[Osiris/API/ObjectLeftCombat]]
+
* [[Osiris/API/ObjectLeftCombat|ObjectLeftCombat]]
* [[Osiris/API/SetCanJoinCombat]]
+
* [[Osiris/API/SetCanJoinCombat|SetCanJoinCombat]]
 
    
 
    
[[Category:Osiris Calls]]
+
[[Category:Osiris Calls|LeaveCombat]]

Latest revision as of 06:38, 23 October 2018

Full Definition(s)
  • call LeaveCombat([in](GUIDSTRING)_Target)
Description

Makes _Target leave the combat it's currently involved it. Should not be called if _Target is currently not in combat.

Notes
  • Unless you first teleported _Target away to a safe location, it's quite likely that it will rejoin the same combat during the next frame. If you wish to prevent it from rejoining any further combat, call SetCanJoinCombat instead (but be careful to restore it again later in case this is done for a player).
See Also