Difference between revisions of "Osiris/API/CharacterCanReactToCrime"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * call '''CharacterCanReactToCrime'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[in]'''''(STRING)'''''_crimeType''', '''[out]'''''(INTEG...")
 
(call -> query, put into standard template form)
Line 1: Line 1:
 
===== Full Definition(s) =====
 
===== Full Definition(s) =====
* call '''CharacterCanReactToCrime'''('''[in]'''''(CHARACTERGUID)'''''_character''', '''[in]'''''(STRING)'''''_crimeType''', '''[out]'''''(INTEGER)'''''_bool''')
+
* query '''CharacterCanReactToCrime'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(STRING)'''''_CrimeType''', '''''[out]'''(INTEGER)'''''_Bool''')
 
===== Description =====
 
===== Description =====
Checks if character can react to a crime type.
+
Checks if '''_Character''' has a defined reaction to a crime.
 +
===== Return Values =====
 +
* '''Success/Failure''': Fails if '''_Character''' or '''_CrimeType''' does not exist.
 +
* '''_bool''': '''1''' if '''_Character''' has a primary or secondary [[Generic_behaviour#Generic_Behaviour_Definition|reaction]] for the crime of type '''_CrimeType''' tension level of the [[Generic_behaviour#Crime_Area|crime area's]] in which it is located.
 
===== Notes =====
 
===== Notes =====
* '''_crimeType''': Name of the crime from crimes table.
+
* The result of this function is unaffected by [[Osiris/API/CharacterDisableCrime|disabled]] or [[Osiris/API/CrimeIgnoreCrime|ignored]] crimes for/by '''_Character'''.
 +
===== See Also =====
 +
* [[Osiris/API/CharacterCanSpotCrimes|CharacterCanSpotCrimes]]
 +
* [[Osiris/API/CharacterDisableAllCrimes|CharacterDisableAllCrimes]]
 +
* [[Osiris/API/CharacterDisableCrime||CharacterDisableCrime|]]
 +
* [[Osiris/API/CharacterEnableAllCrimes|CharacterEnableAllCrimes]]
 +
* [[Osiris/API/CharacterEnableCrime||CharacterEnableCrime|]]
 +
* [[Osiris/API/CharacterIsCrimeEnabled|CharacterIsCrimeEnabled]]
 +
* [[Osiris/API/CrimeAreaSetTensionModifier|CrimeAreaSetTensionModifier]]
 +
* [[Osiris/API/CrimeAreaGetTensionModifier|CrimeAreaGetTensionModifier]]
 +
* [[Osiris/API/CrimeAreaResetTensionModifier|CrimeAreaResetTensionModifier]]
 +
* [[Osiris/API/CrimeGetTension|CrimeGetTension]]
 +
* [[Osiris/API/CrimeGetType|CrimeGetType]]
 +
* [[Osiris/API/CrimeIgnoreCrime|CrimeIgnoreCrime]]
 +
* [[Osiris/API/CrimeIsAnyNPCGoingToReact|CrimeIsAnyNPCGoingToReact]]
 +
* [[Osiris/API/RegisterCrime|RegisterCrime]]
  
 
[[Category:Osiris Queries|CharacterCanReactToCrime]]
 
[[Category:Osiris Queries|CharacterCanReactToCrime]]
 
[[Category:Osiris Queries (Added in DOS2DE)|CharacterCanReactToCrime]]
 
[[Category:Osiris Queries (Added in DOS2DE)|CharacterCanReactToCrime]]

Revision as of 22:09, 13 September 2018

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

Checks if _Character has a defined reaction to a crime.

Return Values
  • Success/Failure: Fails if _Character or _CrimeType does not exist.
  • _bool: 1 if _Character has a primary or secondary reaction for the crime of type _CrimeType tension level of the crime area's in which it is located.
Notes
  • The result of this function is unaffected by disabled or ignored crimes for/by _Character.
See Also