Difference between revisions of "CastImmediateOnSelf"

From GECK

(Examples)
Line 1: Line 1:
==Description==
+
{{Function
 
+
|origin = GECK1
'''CastImmediateOnSelf''' causes the actor to cast the spell immediately on himself bypassing the casting animation. This works for spells that are target self.
+
|summary = Causes the actor to cast the spell immediately on himself bypassing the casting animation. This works for spells that are target self.
 
+
|name = CastImmediateOnSelf
==Syntax==
+
|alias = CIOS
 
+
|returnType = void
  [''ObjectREF''.]CastImmediateOnSelf <spell ID>
+
  |referenceType = [ObjectRefID]
 
+
  |arguments =
  CIOS <spell ID>
+
  {{FunctionArgument
 
+
  |Name = SpellID
==Examples==
+
  |Type = ref
  myRef.CastImmediateOnSelf mySpell
+
  |Optional = n
 +
  }}
 +
  |example = myRef.CastImmediateOnSelf mySpell
  
 
  SydneyRef.CIOS Stimpak
 
  SydneyRef.CIOS Stimpak
 +
}}
  
 
==Notes==
 
==Notes==

Revision as of 05:47, 15 January 2011

A function included in the GECK version 1.1.0.36.

Description

Causes the actor to cast the spell immediately on himself bypassing the casting animation. This works for spells that are target self.

Syntax

[ObjectRefID].CastImmediateOnSelf SpellID:ref 

Or:

[ObjectRefID].CIOS SpellID:ref

Example

myRef.CastImmediateOnSelf mySpell
SydneyRef.CIOS Stimpak

Notes

  • This can also be used with ingestible items, by substituting the item's Form ID for the spell ID
  • In practice this will be often be used similarly to adding an ability (something that you want to effect the actor, but that you don't want him "casting"), however, rather than adding it to the base object (as addSpell does) CastImmediateOnSelf will only affect the reference and has a duration (because it is a spell, rather than an ability).
  • Caveat: This function only works with self targeted spells.
  • This function is new in the GECK, and was not available in the TES4 Construction Set.

See also

Personal tools