Difference between revisions of "GetBaseObject - ActiveMagicEffect"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
(Created page with 'Category:Scripting Category:Papyrus '''Member of:''' ActiveMagicEffect Script Obtains the MagicEffect this active magic effect is based on. =…')
 
 
(One intermediate revision by one other user not shown)
Line 7: Line 7:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
MagicEffect Function GetBaseObject()
MagicEffect Function GetBaseObject() native
</source>
</source>


Line 21: Line 21:
MagicEffect lightEffect = ActiveLightEffect.GetBaseObject()
MagicEffect lightEffect = ActiveLightEffect.GetBaseObject()
</source>
</source>
== Notes ==
* If the duration of a magic effect is 0, or if a magic effect has the ''No Duration'' flag, this function returns none.


== See Also ==
== See Also ==
*[[ActiveMagicEffect Script]]
*[[ActiveMagicEffect Script]]
*[[MagicEffect Script]]
*[[MagicEffect Script]]

Latest revision as of 06:57, 13 July 2023

Member of: ActiveMagicEffect Script

Obtains the MagicEffect this active magic effect is based on.

Syntax[edit | edit source]

MagicEffect Function GetBaseObject() native

Parameters[edit | edit source]

None

Return Value[edit | edit source]

The MagicEffect this active effect is based on.

Examples[edit | edit source]

; Obtain the magic effect the active effect is based on
MagicEffect lightEffect = ActiveLightEffect.GetBaseObject()

Notes[edit | edit source]

  • If the duration of a magic effect is 0, or if a magic effect has the No Duration flag, this function returns none.

See Also[edit | edit source]