Difference between revisions of "ActiveMagicEffect Script"

1,060 bytes added ,  20:00, 3 October 2017
Added a Special Edition Exclusive section with associated events.
imported>CraftySentinel
imported>Texashokies
(Added a Special Edition Exclusive section with associated events.)
 
(5 intermediate revisions by 3 users not shown)
Line 86: Line 86:
'''[[UnregisterForUpdateGameTime - Form|UnregisterForUpdateGameTime]]()
'''[[UnregisterForUpdateGameTime - Form|UnregisterForUpdateGameTime]]()
*Unregisters this magic effect from game time update events.
*Unregisters this magic effect from game time update events.


== SKSE Member Functions ==
== SKSE Member Functions ==
Line 95: Line 94:
*Returns the Time Elapsed of the magic effect.
*Returns the Time Elapsed of the magic effect.


'''Float [[GetMagnitude() - ActiveMagicEffect|GetMagnitude]]()'''
'''Float [[GetMagnitude - ActiveMagicEffect|GetMagnitude]]()'''
*Return the magnitude of the active effect.
*Return the magnitude of the active effect.
'''[[RegisterForNiNodeUpdate]]()'''
*Registers the script for when a QueueNiNodeUpdate is called
'''[[UnregisterForNiNodeUpdate]]()'''
*Unregisters the script for when a QueueNiNodeUpdate is called
== Events ==
== Events ==
'''[[OnAnimationEvent - Form|OnAnimationEvent]](ObjectReference ''akSource'', String ''asEventName'')'''
'''[[OnAnimationEvent - Form|OnAnimationEvent]](ObjectReference ''akSource'', String ''asEventName'')'''
Line 131: Line 137:
*Received at periodic intervals of game time, if the magic effect is registered.
*Received at periodic intervals of game time, if the magic effect is registered.


== Special Edition Exclusive Events ==
'''[[OnLycanthropyStateChanged - ActiveMagicEffect|OnLycanthropyStateChanged]](Bool ''abIsWerewolf'')'''
*Received when the lycanthropy state of this actor changes (when SendLycanthropyStateChanged is called)
'''[[OnPlayerFastTravelEnd - ActiveMagicEffect|OnPlayerFastTravelEnd]](Float ''afTravelGameTimeHours'')'''
*Received when the player finishes fast travel, gives the duration of game time the travel took
'''[[OnVampirismStateChanged - ActiveMagicEffect|OnVampirismStateChanged]](bool ''abIsVampire'')'''
*Received when the vampirism state of this actor changes (when SendVampirismStateChanged is called)
'''[[OnVampireFeed - ActiveMagicEffect|OnVampireFeed]](Actor ''akTarget'')'''
*Received when StartVampireFeed is called on an actor
== SKSE Events ==
'''[[OnNiNodeUpdate]](ObjectReference ''akActor'')'''


== Notes ==
== Notes ==
Anonymous user