Difference between revisions of "RemoteCast - Spell"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>MofoMojo
imported>MofoMojo
Line 13: Line 13:
== Parameters ==
== Parameters ==
*akSource: The [[ObjectReference Script|ObjectReference]] from which to cast the spell.  The source must be able to cast this spell.
*akSource: The [[ObjectReference Script|ObjectReference]] from which to cast the spell.  The source must be able to cast this spell.
*akBlameActor: The [[Actor Script|Actor]] who will be taking blame for the spell if adding it to a target would cause a crime. Note, if this spell has an effect archtype of ReAnimate it will put the target under control of the blameactor.  
*akBlameActor: The [[Actor Script|Actor]] who will be taking blame for the spell if adding it to a target would cause a crime.  
*akTarget: An optional [[ObjectReference Script|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.
*akTarget: An optional [[ObjectReference Script|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
**'''Default''': None

Revision as of 15:41, 16 March 2012

Member of: Spell Script

Casts this spell from the specified object reference with a specified Actor getting the "blame" for the spell if it could cause a crime to occur, optionally toward a target object reference.

Syntax

Function RemoteCast(ObjectReference akSource, Actor akBlameActor, ObjectReference akTarget = None) native

Parameters

  • akSource: The ObjectReference from which to cast the spell. The source must be able to cast this spell.
  • akBlameActor: The Actor who will be taking blame for the spell if adding it to a target would cause a crime.
  • 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.

Examples

; Have the box cast a fireball, but blame the player!
Fireball.RemoteCast(Box, Game.GetPlayer())


; Have the box cast a fireball at the victim, but blame the player!
Fireball.RemoteCast(Box, Game.GetPlayer(), Victim)

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, this parameter will be ignored.

See Also