Difference between revisions of "Osiris/API/CharacterIgnoreActiveCrimes"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * call '''CharacterIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[out]'''''(INTEGER)'''''_bool''') ===== Description =...") |
m (call -> query, put into standard template form) |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * | + | * query '''CharacterIgnoreActiveCrimes'''('''[in]'''''(CHARACTERGUID)'''''_Character''', '''[out]'''''(INTEGER)'''''_Bool''') |
===== Description ===== | ===== 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 [[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. | ||
| − | * | + | * 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]] | ||
Revision as of 21:52, 2 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.
