Difference between revisions of "Disease HasDisease"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (Created page with '{{dafunction |name = Disease_HasDisease |brief = Returns whether or not a character has a Disease |param1type = object |param1name = oCharacter |param1desc = the Creature to che...') |
m (Fixing source, adding categories) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name = Disease_HasDisease | + | |name = Disease_HasDisease |
| − | |brief = Returns whether or not a character has a | + | |brief = Returns whether or not a character has a disease |
| − | |param1type = object | + | |param1type = object |
| − | |param1name = oCharacter | + | |param1name = oCharacter |
| − | |param1desc = | + | |param1desc = the Creature to check |
|param1default = | |param1default = | ||
| − | |param2type = int | + | |param2type = int |
| − | |param2name = nDiseaseID | + | |param2name = nDiseaseID |
| − | |param2desc = the Disease to check for. If -1, it will return TRUE if ANY disease is present. | + | |param2desc = the Disease to check for. If -1, it will return TRUE if ANY disease is present. |
|param2default = | |param2default = | ||
| − | |returntype = int | + | |returntype = int |
| − | |returndesc = TRUE if the Creature has the Disease; otherwise FALSE | + | |returndesc = TRUE if the Creature has the Disease; otherwise FALSE |
| − | |sourcefile = sys_disease | + | |sourcefile = sys_disease |
| − | |sourcemodule = Core Resources | + | |sourcemodule = Core Game Resources |
}} | }} | ||
| − | |||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | + | Checks if a character currently has a certain disease effect applied to him. | |
| − | Checks if a | + | Disease effects are defined in the [[diseases 2da]] file. |
| − | + | ||
| − | Disease | + | |
| − | + | ||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | |||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
<!-- == See also == --> | <!-- == See also == --> | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| + | |||
| + | [[Category:Creature functions]] | ||
| + | [[Category:Disease functions]] | ||
Latest revision as of 14:27, 27 March 2012
Returns whether or not a character has a disease
- Parameters:
- oCharacter
- the Creature to check
- nDiseaseID
- the Disease to check for. If -1, it will return TRUE if ANY disease is present.
- Returns:
- TRUE if the Creature has the Disease; otherwise FALSE
- Source:
- Core Game Resources.sys_disease
Description
Checks if a character currently has a certain disease effect applied to him. Disease effects are defined in the diseases 2da file.
