Difference between revisions of "IsSpellHostile"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
m (GetSpellHostile moved to IsSpellHostile: this function name actually works.)
imported>DragoonWraith
(updating)
Line 3: Line 3:


'''Syntax:'''
'''Syntax:'''
  (isHostile:bool) GetSpellHostile spell:ref
  (isHostile:bool) IsSpellHostile spell:ref


Returns 1 if spell is considered hostile.
Returns 1 if spell is considered hostile.


== Notes ==
== Notes ==
* '''In the current beta version of v0015, beta 1, GetSpellHostile will get an Unknown Command error in the CS.'''
* '''In the OBSE v0015, beta 1 documentation, this function is listed as GetSpellHostile.'''
* In most cases, a spell is hostile so long as it has at least one hostile effect.
* In most cases, a spell is hostile so long as it has at least one hostile effect.
* [[SetSpellHostile]] may override this, so a spell with no hostile effects may be considered hostile, or a spell with hostile effects may be considered non-hostile.
* [[SetSpellHostile]] may override this, so a spell with no hostile effects may be considered hostile, or a spell with hostile effects may be considered non-hostile.

Revision as of 16:10, 26 May 2008


A command for Oblivion Script Extender

Syntax:

(isHostile:bool) IsSpellHostile spell:ref

Returns 1 if spell is considered hostile.

Notes

  • In the OBSE v0015, beta 1 documentation, this function is listed as GetSpellHostile.
  • In most cases, a spell is hostile so long as it has at least one hostile effect.
  • SetSpellHostile may override this, so a spell with no hostile effects may be considered hostile, or a spell with hostile effects may be considered non-hostile.
  • Removing all hostile effects from a hostile spell or adding hostile effects to a non-hostile spell will not update the hostility of the spell automatically.

See Also