Difference between revisions of "GetPlayerSpell"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
(renamed)
 
imported>WereWolf
Line 2: Line 2:


'''Syntax:'''
'''Syntax:'''
  GetPlayerSpell
  (spell:ref) GetPlayerSpell


Returns the player's active spell.
Returns the player's active spell.
Line 9: Line 9:


  ref spell
  ref spell
  set spell to GetPlayerSpell
  set spell to GetPlayerSpell
  player.Cast spell
  player.Cast spell


==Notes==
==Notes==
*Removing the active Spell should be done with caution.  OBSE's developers have not found the player's spell list yet, so after you remove the active spell, GetActiveSpell will return 0 until the user selects a new spell. In the future it will always return the spell that will be cast, once we find that information.
*Removing the active Spell should be done with caution.  OBSE's developers have not found the player's spell list yet, so after you remove the active spell, GetActiveSpell will return 0 until the user selects a new spell. In the future it will always return the spell that will be cast, once we find that information.
*Racial powers can also be removed this way.
*Racial powers can also be removed this way.
Line 20: Line 18:


==See Also==
==See Also==
*[[SelectPlayerSpell]]
*[[SelectPlayerSpell]]


[[Category: OBSE Functions]]
<!--[[Category: OBSE Functions]]
[[Category: OBSE Magic Functions]]
[[Category: OBSE Magic Functions]]
[[Category: OBSE Hero Functions]]
[[Category: OBSE Hero Functions]]-->
 
[[Category: Functions]]
[[Category: Functions (OBSE)]]
[[Category: Magic Functions]]
[[Category: Magic Functions (OBSE)]]
[[Category: Player Functions]]
[[Category: Player Functions (OBSE)]]

Revision as of 03:50, 15 September 2007

A command for Oblivion Script Extender

Syntax:

(spell:ref) GetPlayerSpell

Returns the player's active spell.

Example

ref spell
set spell to GetPlayerSpell
player.Cast spell

Notes

  • Removing the active Spell should be done with caution. OBSE's developers have not found the player's spell list yet, so after you remove the active spell, GetActiveSpell will return 0 until the user selects a new spell. In the future it will always return the spell that will be cast, once we find that information.
  • Racial powers can also be removed this way.
  • This function was called GetActiveSpell in v0004. It was renamed to match Oblivion's SelectPlayerSpell.

See Also