Difference between revisions of "Osiris/API/CharacterCanIgnoreActiveCrimes"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * call '''CharacterCanIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[out]'''''(INTEGER)'''''_bool''') ===== Descriptio...")
 
m (call -> query, put into standard template form)
Line 1: Line 1:
 
===== Full Definition(s) =====
 
===== Full Definition(s) =====
* call '''CharacterCanIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[out]'''''(INTEGER)'''''_bool''')
+
* query '''CharacterCanIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_Character''', '''[out]'''''(INTEGER)'''''_Bool''')
 
===== Description =====
 
===== Description =====
Check whether all current pending crimes of a player character can be removed.
+
Check whether all unresolved crimes registered for the player character '''_Character''' can be removed.
 +
===== 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''' can be removed (= permanently ignored), '''0''' otherwise.
 +
===== Notes =====
 +
* The only case in which this query can fail (other than by specifying invalid parameters), is when '''_Character''' is currently being confronted for one their crimes (= in a crime dialog).
 +
* This query does not actually ignore/stop any crimes. If this query succeeds, use [[Osiris/API/CharacterIgnoreActiveCrimes|CharacterIgnoreCharacterActiveCrimes]] to perform the operation.
 +
===== See Also =====
 +
* [[Osiris/API/CharacterIgnoreActiveCrimes|CharacterIgnoreActiveCrimes]]
 +
* [[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|CharacterCanIgnoreActiveCrimes]]
 
[[Category:Osiris Queries|CharacterCanIgnoreActiveCrimes]]
 
[[Category:Osiris Queries (Added in DOS2DE)|CharacterCanIgnoreActiveCrimes]]
 
[[Category:Osiris Queries (Added in DOS2DE)|CharacterCanIgnoreActiveCrimes]]

Revision as of 21:49, 2 September 2018

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

Check whether all unresolved crimes registered for the player character _Character can be removed.

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 can be removed (= permanently ignored), 0 otherwise.
Notes
  • The only case in which this query can fail (other than by specifying invalid parameters), is when _Character is currently being confronted for one their crimes (= in a crime dialog).
  • This query does not actually ignore/stop any crimes. If this query succeeds, use CharacterIgnoreCharacterActiveCrimes to perform the operation.
See Also