Difference between revisions of "CastImmediateOnSelf"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)Functions\]\] +Category:\1Functions\nCategory:\1Functions (GECK 1.0))) |
imported>Yukichigai |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
== | {{Function | ||
|origin = GECK1 | |||
|summary = Causes the actor to invoke the [[Actor Effect]] immediately on themselves bypassing the casting animation. This works for Actor Effects that are target self. | |||
|name = CastImmediateOnSelf | |||
|alias = CIOS | |||
|returnType = void | |||
|referenceType = [ObjectRefID] | |||
|arguments = | |||
{{FunctionArgument | |||
|Name = SpellID | |||
|Type = ref | |||
|Optional = n | |||
}} | |||
|example = myRef.CastImmediateOnSelf mySpell | |||
SydneyRef.CIOS Stimpak | |||
}} | |||
== | ==Limitations== | ||
*This function only works with self targeted Actor Effects (i.e. the "Self" selection is available under "Range" for each spell effect). | |||
*This function only works for Actor Effects which have a specified duration greater than zero. A duration of zero for any [[Base Effect]] will result in the effect not being activated, even if the effect has the "No Duration" box checked. | |||
**This limitation can be effectively bypassed by setting the duration to a very large number. Durations as long as 3,650 days can be used without issue. | |||
==Notes== | ==Notes== | ||
*This can also be used with [[Ingestible]] items, by substituting the item's Form ID for the Actor Effect 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). | *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). | ||
*This function is new in the GECK, and was not available in the TES4 Construction Set. | *This function is new in the GECK, and was not available in the TES4 Construction Set. | ||
| Line 22: | Line 32: | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Functions (GECK 1. | [[Category:Functions (GECK 1.1)]] | ||
[[Category:Game Effect Functions]] | [[Category:Game Effect Functions]] | ||
[[Category:Game Effect Functions (GECK 1. | [[Category:Game Effect Functions (GECK 1.1)]] | ||
[[Category:Godsend Functions]] | [[Category:Godsend Functions]] | ||
[[Category:Godsend Functions (GECK 1. | [[Category:Godsend Functions (GECK 1.1)]] | ||
Latest revision as of 01:27, 5 August 2013
< [[::Category:Functions|Category:Functions]]
A function included in the GECK version 1.1.0.36.
Description
Causes the actor to invoke the Actor Effect immediately on themselves bypassing the casting animation. This works for Actor Effects that are target self.
Syntax
[ObjectRefID].CastImmediateOnSelf SpellID:ref
Or:
[ObjectRefID].CIOS SpellID:ref
Example
myRef.CastImmediateOnSelf mySpell
SydneyRef.CIOS Stimpak
Limitations
- This function only works with self targeted Actor Effects (i.e. the "Self" selection is available under "Range" for each spell effect).
- This function only works for Actor Effects which have a specified duration greater than zero. A duration of zero for any Base Effect will result in the effect not being activated, even if the effect has the "No Duration" box checked.
- This limitation can be effectively bypassed by setting the duration to a very large number. Durations as long as 3,650 days can be used without issue.
Notes
- This can also be used with Ingestible items, by substituting the item's Form ID for the Actor Effect 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).
- This function is new in the GECK, and was not available in the TES4 Construction Set.