The ActiveMagicEffect script is a part of Fallout 4’s Papyrus scripting ecosystem. It is included with the base game.
For this script, the Papyrus index knows about:
- 83 events
- 6 functions
Inheritance Tree
No indexed scripts extend this script.
Structs
The Papyrus Index is still under construction. Structs have not been implemented yet.
Properties
No properties found.
Events
- Found in:
- Vanilla
eventOnEffectStart(ActorakTarget, ActorakCaster)Event called when the active magic effect has just started on the specified target.
- Found in:
- Vanilla
eventOnEffectFinish(ActorakTarget, ActorakCaster)Event called when the active magic effect has just finished on the specified target.
- Found in:
- Vanilla
eventOnActivate(ObjectReferenceakActionRef)Event received when this reference is activated
- Found in:
- Vanilla
eventOnCellAttach()Event received when this object's parent cell is attached
- Found in:
- Vanilla
eventOnCellDetach()Event received when this object's parent cell is detached
- Found in:
- Vanilla
eventOnCellLoad()Event received when every object in this object's parent cell is loaded (TODO: Find restrictions)
- Found in:
- Vanilla
eventOnClose(ObjectReferenceakActionRef)Event received when this object is closed
- Found in:
- Vanilla
eventOnContainerChanged(ObjectReferenceakNewContainer, ObjectReferenceakOldContainer)Event received when this object enters, exits, or changes containers
- Found in:
- Vanilla
eventOnDestructionStageChanged(intaiOldStage, intaiCurrentStage)Event received when this reference's destruction stage has changed
- Found in:
- Vanilla
eventOnEquipped(ActorakActor)Event received when this object is equipped by an actor
- Found in:
- Vanilla
eventOnExitFurniture(ObjectReferenceakActionRef)Event received when this furniture is exited.
- Found in:
- Vanilla
eventOnHolotapeChatter(stringastrChatter, floatafNumericData)Event that occurs when a flash program on a holotape wants to communicate with script.
- Found in:
- Vanilla
eventOnHolotapePlay(ObjectReferenceaTerminalRef)Event that occurs when a holotape is played via Pipboy or terminal.
- Found in:
- Vanilla
eventOnItemAdded(FormakBaseItem, intaiItemCount, ObjectReferenceakItemReference, ObjectReferenceakSourceContainer)Event received when an item is added to this object's inventory. If the item is a persistant reference, akItemReference will
point at it - otherwise the parameter will be None- Found in:
- Vanilla
eventOnItemRemoved(FormakBaseItem, intaiItemCount, ObjectReferenceakItemReference, ObjectReferenceakDestContainer)Event received when an item is removed from this object's inventory. If the item is a persistant reference, akItemReference
will point at it - otherwise the parameter will be None- Found in:
- Vanilla
eventOnLockStateChanged()Event received when the lock on this object changes
- Found in:
- Vanilla
eventOnOpen(ObjectReferenceakActionRef)Event received when this object is opened
- Found in:
- Vanilla
eventOnPipboyRadioDetection(boolabDetected)Event that occurs when the Pipboy enters/leaves the outer-radius of this radio ref
- Found in:
- Vanilla
eventOnPlayerDialogueTarget()Event received when ref goes into dialogue with player
- Found in:
- Vanilla
eventOnPowerOn(ObjectReferenceakPowerGenerator)Event received when a workshop item receives power
- Found in:
- Vanilla
eventOnPowerOff()Event received when a workshop loses all power
- Found in:
- Vanilla
eventOnSpellCast(FormakSpell)Event received when a spell is cast by this object
- Found in:
- Vanilla
eventOnTranslationAlmostComplete()Event received when translation is almost complete (from a call to TranslateTo, "almost" is determined by a gamesetting, default is 90% of the way)
- Found in:
- Vanilla
eventOnTranslationComplete()Event received when translation is complete (from a call to TranslateTo)
- Found in:
- Vanilla
eventOnTranslationFailed()Event received when translation is aborted (from a call to StopTranslateTo)
- Found in:
- Vanilla
eventOnTrapHitStart(ObjectReferenceakTarget, floatafXVel, floatafYVel, floatafZVel, floatafXPos, floatafYPos, floatafZPos, intaeMaterial, boolabInitialHit, intaeMotionType)Event recieved when this starts hitting a target
- Found in:
- Vanilla
eventOnTrapHitStop(ObjectReferenceakTarget)Event recieved when this stops hitting a target
- Found in:
- Vanilla
eventOnTriggerEnter(ObjectReferenceakActionRef)Event received when this trigger volume is entered
- Found in:
- Vanilla
eventOnTriggerLeave(ObjectReferenceakActionRef)Event received when this trigger volume is left
- Found in:
- Vanilla
eventOnUnequipped(ActorakActor)Event received when this object is unequipped by an actor
- Found in:
- Vanilla
eventOnWorkshopMode(boolaStart)Event received when the player enters or leaves Workshop Mode
- Found in:
- Vanilla
eventOnWorkshopObjectDestroyed(ObjectReferenceakReference)Event received when a workshop item is destroyed ( removed from world and added back to workshop )
- Found in:
- Vanilla
eventOnWorkshopObjectGrabbed(ObjectReferenceakReference)Event received when the player grabs an existing object reference for edit while in Workshop mode.
- Found in:
- Vanilla
eventOnWorkshopObjectMoved(ObjectReferenceakReference)Event received when an existing workshop item is moved in the world
- Found in:
- Vanilla
eventOnWorkshopObjectPlaced(ObjectReferenceakReference)Event received when a workshop item is placed in the world
- Found in:
- Vanilla
eventOnWorkshopNPCTransfer(LocationakNewWorkshop, KeywordakActionKW)Event that occurs when a workshop NPC is directed to move to another settlement
- Found in:
- Vanilla
eventOnWorkshopObjectRepaired(ObjectReferenceakReference)Event received when a workshop item has been repaired
- Found in:
- Vanilla
eventOnCombatStateChanged(ActorakTarget, intaeCombatState)Event that is triggered when this actor's combat state against the target changes
State is as follows:
0 - not in combat
1 - in combat
2 - searching- Found in:
- Vanilla
eventOnCommandModeCompleteCommand(intaeCommandType, ObjectReferenceakTarget)Event received when the actor completes a command in command mode.
Type is as follows:
0 - None
1 - Call
2 - Follow
3 - Move
4 - Attack
5 - Inspect
6 - Retrieve
7 - Stay
8 - Release
9 - Heal- Found in:
- Vanilla
eventOnCommandModeEnter()Event received when the player begins commanding this actor.
- Found in:
- Vanilla
eventOnCommandModeExit()Event received when the player ends commanding this actor.
- Found in:
- Vanilla
eventOnCommandModeGiveCommand(intaeCommandType, ObjectReferenceakTarget)Event received when the player gives actor a command in command mode.
Type is as follows:
0 - None
1 - Call
2 - Follow
3 - Move
4 - Attack
5 - Inspect
6 - Retrieve
7 - Stay
8 - Release
9 - Heal- Found in:
- Vanilla
eventOnCompanionDismiss()Received when player dismisses teammate companion
- Found in:
- Vanilla
eventOnConsciousnessStateChanged(boolabUnconscious)Event that is triggered when this actor's consciousness state changes
- Found in:
- Vanilla
eventOnCripple(ActorValueakActorValue, boolabCrippled)Recieved immeadiately after a limb has become crippled or uncrippled.
- Found in:
- Vanilla
eventOnDeferredKill(ActorakKiller)Event that is triggered when this actor gets a deferred kill added
(they were in deferred kill mode and got "killed")- Found in:
- Vanilla
eventOnDifficultyChanged(intaOldDifficulty, intaNewDifficulty)Event received when the player changes their difficulty
Type is as follows:
0 - Very Easy
1 - Easy
2 - Normal
3 - Hard
4 - Very Hard
5 - Survival (no Hardcore) DEFUNCT
6 - Survival w/ Hardcore- Found in:
- Vanilla
eventOnEnterBleedout()Event received when an actor enters bleedout. (only if this alias points at an actor)
- Found in:
- Vanilla
eventOnEnterSneaking()Event received when an actor enters sneaking.
- Found in:
- Vanilla
eventOnEscortWaitStart()Event received when this actor is in an Escort procedure and begins waiting for the escorted actor to catch up.
- Found in:
- Vanilla
eventOnEscortWaitStop()Event received when this actor is in an Escort procedure and stops waiting because the escorted actor has caught up.
- Found in:
- Vanilla
eventOnGetUp(ObjectReferenceakFurniture)Event that is triggered when this actor leaves the furniture
- Found in:
- Vanilla
eventOnItemEquipped(FormakBaseObject, ObjectReferenceakReference)Event received when this actor equips something - akReference may be None if object is not persistent
- Found in:
- Vanilla
eventOnItemUnequipped(FormakBaseObject, ObjectReferenceakReference)Event received when this actor unequips something - akReference may be None if object is not persistent
- Found in:
- Vanilla
eventOnLocationChange(LocationakOldLoc, LocationakNewLoc)Event that is triggered when this actor changes from one location to another
- Found in:
- Vanilla
eventOnPackageChange(PackageakOldPackage)Event received when this actor's package changes
- Found in:
- Vanilla
eventOnPackageEnd(PackageakOldPackage)Event received when this actor's package ends
- Found in:
- Vanilla
eventOnPackageStart(PackageakNewPackage)Event received when this actor starts a new package
- Found in:
- Vanilla
eventOnPartialCripple(ActorValueakActorValue, boolabCrippled)Recieved immeadiately after the limb of a robot (or other actor whose race allows sub-segment damage) has become (or ceased to be) partially crippled.
- Found in:
- Vanilla
eventOnPickpocketFailed()Received when the player fails to pickpocket this actor
- Found in:
- Vanilla
eventOnPlayerCreateRobot(ActorakNewRobot)Received when player creates a new robot
- Found in:
- Vanilla
eventOnPlayerEnterVertibird(ObjectReferenceakVertibird)Received when player enters vertibird
- Found in:
- Vanilla
eventOnPlayerFallLongDistance(floatafDamage)Received when player takes fall damage
- Found in:
- Vanilla
eventOnPlayerFireWeapon(FormakBaseObject)Received when player fires a weapon out of combat and based on timer
- Found in:
- Vanilla
eventOnPlayerHealTeammate(ActorakTeammate)Received when player heals his teammate
- Found in:
- Vanilla
eventOnPlayerLoadGame()Received immediately after the player has loaded a save game. A good time to check for additional content.
- Found in:
- Vanilla
eventOnPlayerModArmorWeapon(FormakBaseObject, ObjectModakModBaseObject)Received when player mods a weapon or armor in the menu.
- Found in:
- Vanilla
eventOnPlayerModRobot(ActorakRobot, ObjectModakModBaseObject)Received when the player mods a robot
- Found in:
- Vanilla
eventOnPlayerSwimming()Received when player starts swimming
- Found in:
- Vanilla
eventOnPlayerUseWorkBench(ObjectReferenceakWorkBench)Received when player uses a workbench
- Found in:
- Vanilla
eventOnRaceSwitchComplete()Event received when this actor finishes changing its race
- Found in:
- Vanilla
eventOnSit(ObjectReferenceakFurniture)Event that is triggered when this actor sits in the furniture
- Found in:
- Vanilla
eventOnSpeechChallengeAvailable(ObjectReferenceakSpeaker)Received when player gets a speech challenge in dialogue
Functions
- Found in:
- Vanilla
Obtains the MagicEffect this active magic effect is based on.
- Found in:
- Vanilla
Turns on profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is off- Found in:
- Vanilla
Turns off profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is off
