Difference between revisions of "Cast - Spell"
Jump to navigation
Jump to search
imported>Jbezorg |
imported>Terra Nova (Added example.) |
||
Line 10: | Line 10: | ||
Function Cast(ObjectReference akSource, ObjectReference akTarget = None) native | Function Cast(ObjectReference akSource, ObjectReference akTarget = None) native | ||
</source> | </source> | ||
== Examples == | |||
<source lang="papyrus"> | |||
mySpell.cast(myActivator, playerRef) | |||
; myActivator has cast mySpell on the player! | |||
</source> | |||
== Parameters == | == Parameters == | ||
*akSource: The [[ObjectReference Script|ObjectReference]] from which to cast the spell. The source must be able to cast this spell (testings seem to show anything will work, regardless whether they have the spell or not). | *akSource: The [[ObjectReference Script|ObjectReference]] from which to cast the spell. The source must be able to cast this spell (testings seem to show anything will work, regardless whether they have the spell or not). |
Revision as of 04:41, 27 December 2013
Member of: Spell Script
Casts this spell from the specified object reference, optionally toward a target object reference.
Syntax
Function Cast(ObjectReference akSource, ObjectReference akTarget = None) native
Examples
mySpell.cast(myActivator, playerRef)
; myActivator has cast mySpell on the player!
Parameters
- akSource: The ObjectReference from which to cast the spell. The source must be able to cast this spell (testings seem to show anything will work, regardless whether they have the spell or not).
- akTarget: An optional ObjectReference at which to aim the spell. If None is passed and the spell needs a direction, it will be aimed in a default direction.
- Default: None
Return Value
None.
Notes
- This function casts the spell instantaneously. This is mainly desirable only for non-actors, because it will not animate an actor. For instance, the spell will be cast even if the actor's hands are not readied.
- If you wish to make an actor cast a spell using all the normal spellcasting behaviors, please instead use an AI package that includes the UseMagic procedure.
- Actor races can be set to cast magic only in the direction that the actor is facing; if the source is an actor with this racial setting, the target will be ignored.
- It seems that using this function on an actor that doesn't have the spell will work. To add, it will also work on Objects, such as a rock.
- Using this function will invalidate (cause it to return 0/false when it should return 1/true) any ongoing isDualCasting condition checks on akSource.
- isDualCasting will continue to return false after the Cast function is called until akSource stops dual casting.