Difference between revisions of "IsSpellHostile"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
(updating)
imported>DragoonWraith
(updating note)
 
Line 4: Line 4:
'''Syntax:'''
'''Syntax:'''
  (isHostile:bool) IsSpellHostile spell:ref
  (isHostile:bool) IsSpellHostile spell:ref
(isHostile:bool) GetSpellHostile spell:ref


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


== Notes ==
== Notes ==
* '''In the OBSE v0015, beta 1 documentation, this function is listed as GetSpellHostile.'''
* '''In the OBSE v0015, beta 1 documentation, only GetSpellHostile is listed, but this alias has not been implemented.''' Currently, only IsSpellHostile will work. In the final release of v0015, both aliases will work.
* 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.

Latest revision as of 09:32, 27 May 2008


A command for Oblivion Script Extender

Syntax:

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

Returns 1 if spell is considered hostile.

Notes[edit | edit source]

  • In the OBSE v0015, beta 1 documentation, only GetSpellHostile is listed, but this alias has not been implemented. Currently, only IsSpellHostile will work. In the final release of v0015, both aliases will work.
  • 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[edit | edit source]