Osiris/API/CharacterIgnoreActiveCrimes: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(Created page with "===== Full Definition(s) ===== * call '''CharacterIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[out]'''''(INTEGER)'''''_bool''') ===== Description =...")
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
===== Full Definition(s) =====
===== Full Definition(s) =====
* call '''CharacterIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[out]'''''(INTEGER)'''''_bool''')
* query '''CharacterIgnoreActiveCrimes'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Bool''')
===== Description =====
===== Description =====
Remove all current pending crimes of a player character that can be removed.
Tries to remove all unresolved crimes registered for the player character '''_Character'''.
===== Return Values =====
* '''Success/Failure''': Fails if '''_Character''' does not exist or is not in a [[Osiris/API/AddToParty|party]].
* '''_Bool''': '''1''' if all unresolved crimes registered for '''_Character''' could be removed (= permanently ignored), '''0''' otherwise.
===== Notes =====
===== Notes =====
* You can first check with [[Osiris/API/CharacterCanIgnoreActiveCrimes|CharacterCanIgnoreActiveCrimes]] whether all crimes for the character can be removed.
* Returns failure if some crime cannot be removed. This can happen if a player is currently being interrogated for a crime.  
* Returns failure if some crime cannot be removed. This can happen if a player is currently being interrogated for a crime.  
* Despite failure, every crime that can be removed is removed.
* In case of failure, every crime that could be removed is still removed.
 
===== See Also =====
* [[Osiris/API/CharacterCanIgnoreActiveCrimes|CharacterCanIgnoreActiveCrimes]]
* [[Osiris/API/CharacterIgnoreCharacterActiveCrimes|CharacterIgnoreCharacterActiveCrimes]]
* [[Osiris/API/CharacterStopCrime|CharacterStopCrime]]
* [[Osiris/API/CharacterStopCrimeWithID|CharacterStopCrimeWithID]]
* [[Osiris/API/CrimeIgnoreCrime|CrimeIgnoreCrime]]
* [[Osiris/API/CrimeIgnoreAllCrimesForCriminal|CrimeIgnoreAllCrimesForCriminal]]
* [[Osiris/API/RegisterCrime|RegisterCrime]]
* [[Osiris/API/OnCrimeRemoved|OnCrimeRemoved]]
* [[Osiris/API/OnCrimeResolved|OnCrimeResolved]]
 


[[Category:Osiris Queries|CharacterIgnoreActiveCrimes]]
[[Category:Osiris Queries|CharacterIgnoreActiveCrimes]]
[[Category:Osiris Queries (Added in DOS2DE)|CharacterIgnoreActiveCrimes]]
[[Category:Osiris Queries (Added in DOS2DE)|CharacterIgnoreActiveCrimes]]

Latest revision as of 06:35, 3 September 2018

Full Definition(s)
  • query CharacterIgnoreActiveCrimes([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
Description

Tries to remove all unresolved crimes registered for the player character _Character.

Return Values
  • Success/Failure: Fails if _Character does not exist or is not in a party.
  • _Bool: 1 if all unresolved crimes registered for _Character could be removed (= permanently ignored), 0 otherwise.
Notes
  • You can first check with CharacterCanIgnoreActiveCrimes whether all crimes for the character can be removed.
  • Returns failure if some crime cannot be removed. This can happen if a player is currently being interrogated for a crime.
  • In case of failure, every crime that could be removed is still removed.
See Also