The PO3_SKSEFunctions script is a part of Skyrim SE’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like powerofthree's Papyrus Extender (PO3's PE).
For this script, the Papyrus index knows about:
- 369 functions
Inheritance Tree
No indexed scripts extend this script.
Properties
No properties found.
Events
No events found.
Functions
- Found in:
- PO3's PE
- Returns all scripts attached to this active effect.
- Found in:
- PO3's PE
boolfunctionIsScriptAttachedToActiveEffect(ActiveMagicEffectakActiveEffect, stringasScriptName)NativeGlobal- Returns whether the activeEffect has script attached. If scriptName is empty, it will return if the activeEffect has any non-base scripts attached
- Found in:
- PO3's PE
- Returns the spell or form responsible for this active effect
- Found in:
- PO3's PE
- Gets all magiceffects currently on the actor. Filters out inactive and hideinui spells.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
Type Value Normal 0 Explode 1 ExplodeLeadIn 2 Out 3 OutLeadIn 4 Queued 5 GetUp 6 Down 7 - Gets actor knock down state
- Found in:
- PO3's PE
- Found in:
- PO3's PE
Type Value Alive 0 Dying 1 Dead 2 Unconscious 3 Reanimate 4 Recycle 5 Restrained 6 EssentialDown 7 Bleedout 8 - Gets actor life state
- Found in:
- PO3's PE
- Gets actor soul size
- Found in:
- PO3's PE
Type Value Permanent 0 Temporary 1 Damage 2 - Found in:
- PO3's PE
- Get all spells (not abilities) on the actor
- Found in:
- PO3's PE
- See Actor.SetCriticalStage(...)
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets all summons commanded by this actor
- Found in:
- PO3's PE
- Gets the owner of summoned actor
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Checks if the equipped weapon is poisoned
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets poison dose on equipped weapon
- Found in:
- PO3's PE
- Gets weight of all equipped items.
- Found in:
- PO3's PE
- Gets current hair color on actor.
- Fails if hair headpart doesn't exist
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets the actor's current gravity.
- Found in:
- PO3's PE
- Gets object under actor's feet (eg. table).
- Does not work if the player is standing on the ground.
- Found in:
- PO3's PE
- Returns true if the actor is offering services (ie. barter)
- Found in:
- PO3's PE
DEPRECATED
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- How long the actor has been dead for
- Returns 0.0 if actor is alive
- Found in:
- PO3's PE
- Returns time of death in game days passed
- Found in:
- PO3's PE
- Get vendor faction of actor
- Found in:
- PO3's PE
- HasMagicEffect but checks if the mgef is present on the actor (i.e active and not dispelled)
- Found in:
- PO3's PE
- HasSpell but checks if the spell is present on the actor (i.e active and not dispelled)
- Found in:
- PO3's PE
- Returns whether the actor is in deferred kill mode
- Found in:
- PO3's PE
- Checks if activemagiceffect with given archetype is present on actor. See Magic Effect
- Found in:
- PO3's PE
- Returns whether the actor is in cell water or lava
- Found in:
- PO3's PE
- Found in:
- PO3's PE
Limb Value None -1 Torso 0 Head 1 - Returns whether limb is gone (i.e, the head)
- Found in:
- PO3's PE
- Is actor power attacking?
- Found in:
- PO3's PE
- Is actor a quadruped?
- Found in:
- PO3's PE
- Returns whether target is soul trapped / capable of being soul trapped successfully (if using mods that bypass vanilla soul trap system).
- Found in:
- PO3's PE
boolfunctionApplyPoisonToEquippedWeapon(ActorakActor, PotionakPoison, intaiCount, boolabLeftHand)NativeGlobal- Applies poison with specified dose to the equipped weapon. Weapon must not have poison applied (to modify existing poisons, see
SetEquippedWeaponPoison)
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Adds perks to the actorbase, works on leveled actors/unique NPCs.
- Function serializes data to skse cosave, so perks are applied correctly on loading/reloading saves.
- Found in:
- PO3's PE
- Adds spells to actorbase
- Function serializes data to skse cosave.
- Found in:
- PO3's PE
voidfunctionBlendColorWithSkinTone(ActorakActor, ColorFormakColor, intaiBlendMode, boolabAutoLuminance, floatafOpacity)NativeGlobalBlend Modes
Mode Value Darken 0 Multiply 1 ColorBurn 2 LinearBurn 3 DarkerColor 4 Lighten 5 Screen 6 ColorDodge 7 LinearDodge 8 LighterColor 9 Overlay 10 SoftLight 11 HardLight 12 VividLight 13 LinearLight 14 PinLight 15 HardMix 16 Difference 17 Exclusion 18 Subtract 19 Divide 20 - Blends existing skin color with specified color, using photoshop blend formulas, with alpha (opacity).
- If true, autoLuminance calculates skin tone relative luminance. The opacity value is then used as a multiplier on top of that, final value is clamped to 0-1
- If false, only opacity will be used. Recommend to use autoluminance because colors will not blend well for all skin tones using flat values.
- Found in:
- PO3's PE
- Damage actor health, passing an optional actor to blame.
- Returns if the actor was damaged successfully.
- Found in:
- PO3's PE
- Decapitates living and dead actors. Living actors will not die when this is called!
- Found in:
- PO3's PE
Type Description 0 Disables AI (freeze in place) 1 Paralyze (Paralyze with stiff ragdoll) - Found in:
- PO3's PE
- Quick and dirty hack to instantly kill the actor and set as dead.
- Found in:
- PO3's PE
voidfunctionLaunchArrow(ActorakActor, AmmoakAmmo, WeaponakWeapon, stringasNodeName="", intaiSource=-1, ObjectReferenceakTarget=NONE, PotionakPoison=NONE)NativeGlobalType Description -1 Uses node name or default weapon node if empty 0 Left hand node 1 Right hand node 2 Head node - Launch arrow from given node (with optional target and poison applied)
- Found in:
- PO3's PE
Type Description 0 Left hand 1 Right hand 2 Voice 3 Instant - Launch spell projectile from casting source
- Found in:
- PO3's PE
voidfunctionMixColorWithSkinTone(ActorakActor, ColorFormakColor, boolabManualMode, floatafPercentage)NativeGlobal- Blends existing skin color with specified color.
- True - intensity is manually calculated using percentage 0-1.0, False - automatically calculated using skin tone luminance
- Found in:
- PO3's PE
voidfunctionRemoveAddedSpells(ActorakActor, stringmodName, Keyword[]keywords, boolabMatchAll)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveArmorOfType(ActorakActor, intafArmorType, int[]aiSlotsToSkip, boolabEquippedOnly)NativeGlobal- Found in:
- PO3's PE
- Perk effects may not be removed from unique actors, more testing required.
- Function serializes data to skse cosave
- Found in:
- PO3's PE
- Function serializes data to skse cosave
- Found in:
- PO3's PE
voidfunctionReplaceArmorTextureSet(ActorakActor, ArmorakArmor, TextureSetakSourceTXST, TextureSetakTargetTXST, intaiTextureType=-1)NativeGlobal- Replaces specified source textureset on worn armor with target textureset.
- If texture type is -1, the entire textureset is replaced.
- Otherwise the texture map specified at [textureType] index is replaced (diffuse is 0, normal is 1...)
- Found in:
- PO3's PE
voidfunctionReplaceFaceTextureSet(ActorakActor, TextureSetakMaleTXST, TextureSetakFemaleTXST, intaiTextureType=-1)NativeGlobal- Replaces face textureset. Can be applied to non-unique actors.
- If texture type is -1, the entire textureset is replaced
- Otherwise the texture map specified at [textureType] index is replaced.
- Replacing the entire textureset may cause a visible neckseam.
- Found in:
- PO3's PE
voidfunctionReplaceSkinTextureSet(ActorakActor, TextureSetakMaleTXST, TextureSetakFemaleTXST, intaiSlotMask, intaiTextureType=-1)NativeGlobal- Replaces skin textureset for given slotmask (ie. body/hand).
- Has to be reapplied when re-equipping armor.
- If texture type is -1, the entire textureset is replaced, otherwise the texture map specified at [textureType] index is replaced.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Ranges from 0.0 - 1.0
- Found in:
- PO3's PE
- Set poison on equipped weapon (weapon must have poison already applied)
- Found in:
- PO3's PE
- Set poison dose on equipped weapon (weapon must have poison already applied)
- Found in:
- PO3's PE
*Changes may persist throughout gaming session, even when reloading previous saves.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Sets actor velocity.
- Found in:
- PO3's PE
voidfunctionSetLocalGravityActor(ActorakActor, floatafValue, boolabDisableGravityOnGround)NativeGlobal- Sets actor gravity.
- Negative values will cause them to fly.
- Found in:
- PO3's PE
- Sets alpha on face, base skin form and armor meshes with visible skin.
- Has to be re-applied when armor is un/re-equipped.
- Found in:
- PO3's PE
- Sets skin color (face and body).
- Face shader is switched to
FaceGenRGBTintto allow tint changes. Tintmasks will no longer work. - Has to be re-applied when armor is un/re-equipped.
- Found in:
- PO3's PE
- Sets the flag used by the game to determine soul trapped NPCs
- Found in:
- PO3's PE
- Toggles any hair wigs (geometry with hair shader) found on slots Hair/LongHair
- Found in:
- PO3's PE
Types Value Light 0 Heavy 1 Clothing 2 - Unequips all armor of type, optionally skipping biped slots.
- Found in:
- PO3's PE
- Get association type between 2 NPCs, if any
- Found in:
- PO3's PE
- Gets NPC death item
- Found in:
- PO3's PE
- Get actorbase perk at nth index
- Found in:
- PO3's PE
- Get total actorbase perk count
- Found in:
- PO3's PE
- Gets list of actorbases by association type, OR all actors with relationships if association type is None
- Found in:
- PO3's PE
- Sets NPC death item.
- Can be None.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Returns whether the form has script attached. If scriptName is empty, it will return if the alias has any non-base scripts attached
- Found in:
- PO3's PE
- Gets armor addon's footstep set
- Found in:
- PO3's PE
- Sets armor addon's footstep set
- Found in:
- PO3's PE
string[]functionGetSortedActorNames(KeywordakKeyword, stringasPlural="s)", boolabInvertKeyword)NativeGlobal- Gets name array of all the actors in the area, sorted alphabetically.
- Generic actors are merged (ie. 3 Whiterun Guard(s)).
- Filter keyword optional
- Found in:
- PO3's PE
- Gets name array of NPCs, sorted alphabetically.
- Generic actors are merged (ie. 3 Whiterun Guard(s)).
- Found in:
- PO3's PE
- Adds actor to array. Modifies array directly, it must be initialized!
- Found in:
- PO3's PE
- Adds string to array. Modifies array directly, it must be initialized!
- Found in:
- PO3's PE
- Counts how many instances of a string are in an array.
- Found in:
- PO3's PE
- Alphabetically sorts and returns truncated string array.
- Found in:
- PO3's PE
- Clears can't be taken flag
- Found in:
- PO3's PE
- Clears read flag (and writes it to the save).
- Found in:
- PO3's PE
- Sets can't be taken flag.
- Found in:
- PO3's PE
- Sets read flag (and writes it to the save).
- Found in:
- PO3's PE
- Gets cell north rotation/worldspace north rotation for exterior cells. Rotation is in degrees.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Adds all usable spells to the player, and adds mod prefix to each spell name.
- Found in:
- PO3's PE
- Dumps current actor animation variables to po3_papyrusextender64.log
- Found in:
- PO3's PE
State Description 0 Can't be detected 1 Normal 2 Will always be detected - Returns whether other NPCs can detect this actor.
- Found in:
- PO3's PE
State Description 0 Can never detect others 1 Normal 2 Will always detect others - Returns whether this actor can detect other NPCs.
- Found in:
- PO3's PE
- Returns whether this actor is currently detected by other NPCs
- Ignores NPCs with
DoNotShowOnStealthMeterflag
- Found in:
- PO3's PE
- Force this actor to be always detected by other NPCs
- Found in:
- PO3's PE
- Force this actor to always detect their targets
- Found in:
- PO3's PE
- Prevent this actor from being detected by other NPCs (actor is hidden).
- Found in:
- PO3's PE
- Prevent this actor from detecting other NPCs (actor is blind)
- Found in:
- PO3's PE
- Resets detection state
- Found in:
- PO3's PE
- Resets detecting state
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Returns the total number of effect shaders present/present and active (on objects) within the loaded area.
- Found in:
- PO3's PE
Flags
Flag Value kNoMembraneShader 0x00000001 kMembraneGreyscaleColor 0x00000002 kMembraneGreyscaleAlpha 0x00000004 kNoParticleShader 0x00000008 kEdgeEffectInverse 0x00000010 kAffectSkinOnly 0x00000020 kIgnoreAlpha 0x00000040 kProjectUV 0x00000080 kIgnoreBaseGeometryAlpha 0x00000100 kLighting 0x00000200 kNoWeapons 0x00000400 kParticleAnimated 0x00008000 kParticleGreyscaleColor 0x00010000 kParticleGreyscaleAlpha 0x00020000 kUseBloodGeometry 0x01000000 - Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
voidfunctionSetMembraneColorKeyData(EffectShaderakEffectShader, intaiColorKey, int[]aiRGB, floatafAlpha, floatafTime)NativeGlobal- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
voidfunctionSetParticleColorKeyData(EffectShaderakEffectShader, intaiColorKey, int[]aiRGB, floatafAlpha, floatafTime)NativeGlobal- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
voidfunctionSetParticlePersistentCount(EffectShaderakEffectShader, floatafParticleCount)NativeGlobal- Found in:
- PO3's PE
- Found in:
- PO3's PE
Type Value None -1 Enchantment 6 StaffEnchantment 12 - Returns enchantment type. -1 if is None
- Found in:
- PO3's PE
voidfunctionAddMagicEffectToEnchantment(EnchantmentakEnchantment, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0, string[]asConditionList)NativeGlobal- Found in:
- PO3's PE
voidfunctionAddEffectItemToEnchantment(EnchantmentakEnchantment, EnchantmentakEnchantmentToCopyFrom, intaiIndex, floatafCost=-1)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveMagicEffectFromEnchantment(EnchantmentakEnchantment, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveEffectItemFromEnchantment(EnchantmentakEnchantment, EnchantmentakEnchantmentToMatchFrom, intaiIndex)NativeGlobal- Found in:
- PO3's PE
voidfunctionSetEnchantmentMagicEffect(EnchantmentakEnchantment, MagicEffectakMagicEffect, intaiIndex)NativeGlobal- Found in:
- PO3's PE
- Gets vendor chest reference, if it exists
- Found in:
- PO3's PE
- Get all actors belonging to this faction
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
boolfunctionEvaluateConditionList(FormakForm, ObjectReferenceakActionRef, ObjectReferenceakTargetRef)NativeGlobal- Evaluates condition lists for spells/potions/enchantments/mgefs and returns if they can be fullfilled
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Builds a list of conditions present on the form. Index is for spells/other forms that have lists with conditions
- Some conditions may be skipped (conditions that require non player references, overly complex conditions involving packages/aliases)
- Found in:
- PO3's PE
- Gets form description text, if any
- Found in:
- PO3's PE
- Get form editorID
- Requires powerofthree's Tweaks
- Found in:
- PO3's PE
- Get name of the mod the form originates from (or was last modified by)
- Found in:
- PO3's PE
- Get all non-base scripts attached to this form
- Found in:
- PO3's PE
- Returns whether the form is part of mod
- Found in:
- PO3's PE
- Returns whether the form is temporary (ie. has a formID beginning with FF)
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- returns whether the form has script attached. If scriptName is empty, it will return if the form has any non-base scripts attached
- Found in:
- PO3's PE
- Set record flag
- Found in:
- PO3's PE
- Adds keyword to form. Fails if the form doesn't accept keywords.
- Found in:
- PO3's PE
- Favorites item (must be in inventory) or spell/shout
- Found in:
- PO3's PE
- Removes conditions on the form that were found in the condition list . This is not serialized.
- Index is for spell/magic item effects
- Found in:
- PO3's PE
voidfunctionReplaceKeywordOnForm(FormakForm, KeywordakKeywordAdd, KeywordakKeywordRemove)NativeGlobal- Replaces given keyword with new one on form. Only lasts for a single gaming session. [ported from DienesTools].
- Found in:
- PO3's PE
- Removes keyword from form.
- Found in:
- PO3's PE
- Append the condition list to this form. This is not serialized.
- Index is for spell/magic item effects
- Found in:
- PO3's PE
- Unfavorites item (must be in inventory) or spell/shout
- Found in:
- PO3's PE
Type Value None -1 Perch 0 Lean 1 Sit 2 Sleep 3 - Found in:
- PO3's PE
- Gets all enchantments from base game + mods, filtered using optional keyword array
- Found in:
- PO3's PE
- Gets all forms from base game + mods, filtered using formtype and optional keyword array
- Found in:
- PO3's PE
- Gets all races from base game + mods, filtered using optional keyword array
- Found in:
- PO3's PE
- Gets all spells from base game + mods, filtered using optional keyword array. IsPlayable filters out spells that are not found in spellbooks.
- Found in:
- PO3's PE
Type Value HighProcess 0 MiddleHighProcess 1 MiddleLowProcess 2 LowProcess 3 - Gets all actors by AI processing type.
- See GetActorsByProcessingLevel for more info
- Found in:
- PO3's PE
Form[]functionGetAllFormsInMod(stringasModName, intaiFormType, Keyword[]akKeywords=NONE)NativeGlobal- Gets all forms added by a specified mod/game esm, filtered using formtype and optional keyword array.
- Found in:
- PO3's PE
- Gets all enchantments added by a specified mod/game esm, filtered using optional keyword array.
- Found in:
- PO3's PE
- Gets all races added by a specified mod/game esm, filtered using optional keyword array.
- Found in:
- PO3's PE
Spell[]functionGetAllSpellsInMod(stringasModName, Keyword[]akKeywords=NONE, boolabIsPlayable=false)NativeGlobal- Gets all spells added by a specified mod/game esm, filtered using optional keyword array.
- Found in:
- PO3's PE
- Gets current cell if in interior/attached cells in exterior/sky cell if in worldspace with no attached cells??
- Found in:
- PO3's PE
- Gets form using its editorID
- Found in:
- PO3's PE
- Gets the value of the boolean gamesetting. Returns -1 if gmst is None or not a bool.
- Found in:
- PO3's PE
- Returns whether God Mode is enabled
- Found in:
- PO3's PE
- Gets land height at the specified coordinates.
- Found in:
- PO3's PE
- Gets land material type at the specified coordinates.
- Found in:
- PO3's PE
- Gets exterior worldspace/interior cell gravity.
- Default gravity is [0.0, 0.0, -9.81]
- Found in:
- PO3's PE
- Gets how many actors are in high process
- Found in:
- PO3's PE
- Returns all actors that are currently following the player
- Found in:
- PO3's PE
- Gets the material name of the current surface (land texture) at point
- See Object Reference for material type list
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Returns whether CC Survival Mode is enabled
- False in VR
- Found in:
- PO3's PE
- Clears all faction combat reactions
- Found in:
- PO3's PE
- Sets exterior worldspace/interior cell gravity (ms-2).
- Found in:
- PO3's PE
- Refreshes crosshair text and other elements
- Found in:
- PO3's PE
- Gets hazard art path, eg. "Effects/MyHazardArt.nif"
- Found in:
- PO3's PE
- Get Hazard imagespace modifier
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Get hazard impact data set
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets target interval (duration between casts)
- Found in:
- PO3's PE
Flag Value None 0 PCOnly 0x00000001 InheritDuration 0x00000002 AlignToNormal 0x00000004 InheritRadius 0x00000008 DropToGround 0x00000010 - Found in:
- PO3's PE
- Found in:
- PO3's PE
- Sets hazard art path. Does not work on active hazards
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Get idle animation event name (eg.
attackStart)
- Found in:
- PO3's PE
- Get idle animation file name (eg.
Actors\Character\Behaviors\0_Master.hkx)
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets light fade (brightness).
- Found in:
- PO3's PE
- Gets base light FOV.
- Found in:
- PO3's PE
- Gets light radius as float
- Found in:
- PO3's PE
- Gets light color as RGB array [0-255].
- Found in:
- PO3's PE
- Gets depth bias
- Returns 1 if not set.
- Found in:
- PO3's PE
Type Value HemiShadow 1 Omni 2 OmniShadow 3 Spot 4 SpotShadow 5 - Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Sets light color using RGB array [0-255].
- Array must contain 3 elements (r,g,b).
- Found in:
- PO3's PE
- sets depth bias on light reference. Creates new depth bias extradata on lights that don't have it set.
- Found in:
- PO3's PE
- Sets light type.
- Does not persist between game sessions.
- Found in:
- PO3's PE
- Same as above but for leveled items
- Found in:
- PO3's PE
Form[]functionGetContentFromLeveledActor(LeveledActorakLeveledActor, ObjectReferenceakRef)NativeGlobal- Resolves leveled list based on reference's level and returns an array of forms
- Found in:
- PO3's PE
Form[]functionGetContentFromLeveledSpell(LeveledSpellakLeveledSpell, ObjectReferenceakRef)NativeGlobal- Same as above but for leveled spells
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets associated form (Light for Light spells, Actor for Summon Creature...), if any
- Found in:
- PO3's PE
Effect Archetypes
Archetype Value ValueMod 0 Script 1 Dispel 2 CureDisease 3 Absorb 4 DualValueMod 5 Calm 6 Demoralize 7 Frenzy 8 Disarm 9 CommandSummoned 10 Invisibility 11 Light 12 Darkness 13 NightEye 14 Lock 15 Open 16 BoundWeapon 17 SummonCreature 18 DetectLife 19 Telekinesis 20 Paralysis 21 Reanimate 22 SoulTrap 23 TurnUndead 24 Guide 25 WerewolfFeed 26 CureParalysis 27 CureAddiction 28 CurePoison 29 Concussion 30 ValueAndParts 31 AccumulateMagnitude 32 Stagger 33 PeakValueMod 34 Cloak 35 Werewolf 36 SlowTime 37 Rally 38 EnhanceWeapon 39 SpawnHazard 40 Etherealize 41 Banish 42 SpawnScriptedRef 43 Disguise 44 GrabActor 45 VampireLord 46 - Get effect archetype as string or integer
- Found in:
- PO3's PE
Effect Archetypes
Archetype Value ValueMod 0 Script 1 Dispel 2 CureDisease 3 Absorb 4 DualValueMod 5 Calm 6 Demoralize 7 Frenzy 8 Disarm 9 CommandSummoned 10 Invisibility 11 Light 12 Darkness 13 NightEye 14 Lock 15 Open 16 BoundWeapon 17 SummonCreature 18 DetectLife 19 Telekinesis 20 Paralysis 21 Reanimate 22 SoulTrap 23 TurnUndead 24 Guide 25 WerewolfFeed 26 CureParalysis 27 CureAddiction 28 CurePoison 29 Concussion 30 ValueAndParts 31 AccumulateMagnitude 32 Stagger 33 PeakValueMod 34 Cloak 35 Werewolf 36 SlowTime 37 Rally 38 EnhanceWeapon 39 SpawnHazard 40 Etherealize 41 Banish 42 SpawnScriptedRef 43 Disguise 44 GrabActor 45 VampireLord 46 - Get effect archetype as string or integer
- Found in:
- PO3's PE
- Gets primary actor value as string, if any (FrostResist, SpeedMult).
- Found in:
- PO3's PE
- Gets secondary actor value as string, if any.
- Found in:
- PO3's PE
Type Index Draw/Sheathe 0 Charge 1 Ready 2 Release 3 Concentration Cast Loop 4 On Hit 5 - Gets Sound attached to index of Sound type specified in magic effect.
- Found in:
- PO3's PE
- Sets associated form (Light for Light spells, Actor for Summon Creature...).
- Can be None
- Found in:
- PO3's PE
voidfunctionSetMagicEffectSound(MagicEffectakMagicEffect, SoundDescriptorakSoundDescriptor, intaiType)NativeGlobal- Sets sound descriptor attached to index of Sound type specified in magic effect.
- Found in:
- PO3's PE
boolfunctionActorInRangeHasEffect(ObjectReferenceakRef, floatafRadius, MagicEffectakEffect, boolabIgnorePlayer)NativeGlobal- Returns true if an actor within range of the reference has the specified magic effect.
- Found in:
- PO3's PE
Form[]functionAddAllItemsToArray(ObjectReferenceakRef, boolabNoEquipped=true, boolabNoFavorited=false, boolabNoQuestItem=false)NativeGlobal- Adds all inventory items to array, filtering out equipped, favourited and quest items.
- Found in:
- PO3's PE
voidfunctionAddAllItemsToList(ObjectReferenceakRef, FormListakList, boolabNoEquipped=true, boolabNoFavorited=false, boolabNoQuestItem=false)NativeGlobal- Found in:
- PO3's PE
Form[]functionAddItemsOfTypeToArray(ObjectReferenceakRef, intaiFormType, boolabNoEquipped=true, boolabNoFavorited=false, boolabNoQuestItem=false)NativeGlobal- Adds inventory items matching formtype to array, filtering out equipped, favourited and quest items.
- Found in:
- PO3's PE
voidfunctionAddItemsOfTypeToList(ObjectReferenceakRef, FormListakList, intaiFormType, boolabNoEquipped=true, boolabNoFavorited=false, boolabNoQuestItem=false)NativeGlobal- Found in:
- PO3's PE
ObjectReference[]functionFindAllReferencesOfFormType(ObjectReferenceakRef, intformType, floatafRadius)NativeGlobal- Finds all references of form type in loaded cells, within radius from ref.
- If afRadius is 0, it will get all references from all attached cells
- Found in:
- PO3's PE
ObjectReference[]functionFindAllReferencesWithKeyword(ObjectReferenceakRef, FormkeywordOrList, floatafRadius, boolabMatchAll)NativeGlobal- Find all references with keyword in loaded cells, within radius from ref.
- If afRadius is 0, it will get all references from all attached cells
- Found in:
- PO3's PE
ObjectReference[]functionFindAllReferencesOfType(ObjectReferenceakRef, FormakFormOrList, floatafRadius)NativeGlobal- Find all references matching base form/in formlist, within radius from ref.
- If afRadius is 0, it will get all references from all attached cells
- Found in:
- PO3's PE
- Gets the first item in inventory that exists in formlist.
- Found in:
- PO3's PE
Quest[]functionGetActiveAssociatedQuests(ObjectReferenceakRef, boolabAllowEmptyStages=true)NativeGlobal- Gets all active quests associated with this reference
- Found in:
- PO3's PE
- Gets activate children
- See IsActivateChild
- Found in:
- PO3's PE
- Gets currently playing animation sequence
- Found in:
- PO3's PE
ActiveMagicEffect[]functionGetActiveMagicEffects(ObjectReferenceakRef, MagicEffectakMagicEffect)NativeGlobal- Gets all active effects on the reference matching the magic effect.
- Found in:
- PO3's PE
Quest[]functionGetAllAssociatedQuests(ObjectReferenceakRef, boolabAllowEmptyStages=true)NativeGlobal- Gets all quests associated with this reference
- Found in:
- PO3's PE
- Gets actor responsible for object.
- Found in:
- PO3's PE
- Get all art objects attached to this object.
- Found in:
- PO3's PE
- Get all effect shaders attached to this object.
- Found in:
- PO3's PE
- Gets closest actor to ref (without returning the reference itself).
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Gets the door which is linked to this load door ref.
- Found in:
- PO3's PE
- Gets all refs linked to akRef. Keyword optional.
- Found in:
- PO3's PE
- Gets the source of the magic effect (spell/enchantment/scroll etc) and the caster.
- Magic effect must be present on the reference.
- Found in:
- PO3's PE
Materials
Material StoneBroken BlockBlade1Hand Meat CarriageWheel MetalLight WoodLight Snow Gravel ChainMetal Bottle Wood Ash Skin BlockBlunt DLC1DeerSkin Insect Barrel CeramicMedium Basket Ice GlassStairs StoneStairs Water DraugrSkeleton Blade1Hand Book Carpet MetalSolid Axe1Hand BlockBlade2Hand OrganicLarge Amulet WoodStairs Mud BoulderSmall SnowStairs StoneHeavy DragonSkeleton Trap BowsStaves Alduin BlockBowsStaves WoodAsStairs SteelGreatSword Grass BoulderLarge StoneAsStairs Blade2Hand BottleSmall BoneActor Sand MetalHeavy DLC1SabreCatPelt IceForm Dragon Blade1HandSmall SkinSmall PotsPans SkinSkeleton Blunt1Hand StoneStairsBroken SkinLarge Organic Bone WoodHeavy Chain Dirt Ghost SkinMetalLarge BlockAxe ArmorLight ShieldLight Coin BlockBlunt2Hand ShieldHeavy ArmorHeavy Arrow Glass Stone WaterPuddle Cloth SkinMetalSmall Ward Web TrailerSteelSword Blunt2Hand DLC1SwingingBridge BoulderMedium - Gets the specified collision shape's havok material types as string array.
- Returns the first material type if nodeName is empty
- Found in:
- PO3's PE
- See ObjectReference.SetMotionType(...)
- Found in:
- PO3's PE
intfunctionGetNumActorsWithEffectInRange(ObjectReferenceakRef, floatafRadius, MagicEffectakEffect, boolabignorePlayer)NativeGlobal- Found in:
- PO3's PE
ActorfunctionGetRandomActorFromRef(ObjectReferenceakRef, floatafRadius, boolabIgnorePlayer)NativeGlobal- Gets random actor near ref (without returning the reference itself).
- Found in:
- PO3's PE
Form[]functionGetQuestItems(ObjectReferenceakRef, boolabNoEquipped=false, boolabNoFavorited=false)NativeGlobal- Found in:
- PO3's PE
- Get all aliases holding this ref
- Found in:
- PO3's PE
- Get object reference count (eg. number of stacked items when dropped from inventory)
- Found in:
- PO3's PE
- Returns the size of the stored soul in a soulgem objectreference
- Found in:
- PO3's PE
- Returns the number of instances of the specified art object (attached using visual effects) on the reference.
- Found in:
- PO3's PE
intfunctionHasEffectShader(ObjectReferenceakRef, EffectShaderakShader, boolabActive=false)NativeGlobal- Returns the number of instances of the specified effect shader on the reference.
- Found in:
- PO3's PE
- Returns whether the reference has NiExtraData (attached to root 3D node). Partial name matches accepted.
- Found in:
- PO3's PE
- Returns whether the reference is currently casting magic
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Returns whether the object reference (or actor) is in water. Function may be unreliable if object bounds are incorrect
- Found in:
- PO3's PE
- Returns whether the object reference's node is in water.
- Found in:
- PO3's PE
- Returns whether the object reference (or actor) is under water. Function may be unreliable if object bounds are incorrect
- Found in:
- PO3's PE
- Is a VIP (actor that is needed by quest)?
- Found in:
- PO3's PE
voidfunctionApplyMaterialShader(ObjectReferenceakRef, MaterialObjectakMatObject, floatdirectionalThresholdAngle)NativeGlobal- Applies material shader to reference (doesn't have to be static)
- Found in:
- PO3's PE
- Wrapper function for AddKeywordToForm.
- Found in:
- PO3's PE
voidfunctionCastEx(ObjectReferenceakRef, FormakSpell, ObjectReferenceakTarget, ActorakBlameActor, intaiSource)NativeGlobal- Found in:
- PO3's PE
- Snaps the object to the nearest navmesh point closest to its current position in the cell.
- Found in:
- PO3's PE
voidfunctionRemoveAllModItems(ObjectReferenceakRef, stringasModName, boolabOnlyUnequip=false)NativeGlobal- Remove all mod added items from this reference, optionally only unequipping them
- Found in:
- PO3's PE
voidfunctionRemoveListFromContainer(ObjectReferenceakRef, FormListakList, boolabNoEquipped=false, boolabNoFavorited=false, boolabNoQuestItem=false, ObjectReferenceakDestination=NONE)NativeGlobal- Removes all items found in the formlist from the container, transferring them to an optional container
- Found in:
- PO3's PE
- Wrapper function for RemoveKeywordFromForm.
- Found in:
- PO3's PE
voidfunctionReplaceKeywordOnRef(ObjectReferenceakRef, KeywordakKeywordAdd, KeywordakKeywordRemove)NativeGlobal- Wrapper function for ReplaceKeywordOnForm.
- Found in:
- PO3's PE
- Plays debug shader on the reference, with normalised RGBA color (or white if empty)
- Found in:
- PO3's PE
- Scales node & collision (bhkBoxShape, bhkSphereShape).
- Entire nif will be scaled if string is empty. Collision has to be directly attached to named nodes.
- Adds "PO3_SCALE" NiExtraData to root node.
- Found in:
- PO3's PE
- Sets the base object of this reference. Does not reload the object reference.
- Found in:
- PO3's PE
voidfunctionSetCollisionLayer(ObjectReferenceakRef, stringasNodeName, intaiCollisionLayer)NativeGlobalCollision Layers
Collision Layer Value kUnidentified 0 kStatic 1 kAnimStatic 2 kTransparent 3 kClutter 4 kWeapon 5 kProjectile 6 kSpell 7 kBiped 8 kTrees 9 kProps 10 kWater 11 kTrigger 12 kTerrain 13 kTrap 14 kNonCollidable 15 kCloudTrap 16 kGround 17 kPortal 18 kDebrisSmall 19 kDebrisLarge 20 kAcousticSpace 21 kActorZone 22 kProjectileZone 23 kGasTrap 24 kShellCasting 25 kTransparentWall 26 kInvisibleWall 27 kTransparentSmallAnim 28 kClutterLarge 29 kCharController 30 kStairHelper 31 kDeadBip 32 kBipedNoCC 33 kAvoidBox 34 kCollisionBox 35 kCameraSphere 36 kDoorDetection 37 kConeProjectile 38 kCamera 39 kItemPicker 40 kLOS 41 kPathingPick 42 kUnused0 43 kUnused1 44 kSpellExplosion 45 kDroppingPick 46 - Sets object 3D root or specified node's collision layer
- Found in:
- PO3's PE
- Sets the door as the new linked door
- Found in:
- PO3's PE
voidfunctionSetEffectShaderDuration(ObjectReferenceakRef, EffectShaderakShader, floatafTime, boolabAbsolute)NativeGlobal- Sets effectshader duration. Internal duration is set when the effectshader begins and does not change with time.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
voidfunctionSetLinkedRef(ObjectReferenceakRef, ObjectReferenceakTargetRef, KeywordakKeyword=NONE)NativeGlobal- Sets linked ref. Pass None into akTargetRef to unset the linked ref.
- Found in:
- PO3's PE
voidfunctionSetMaterialType(ObjectReferenceakRef, stringasNewMaterial, stringasOldMaterial="", stringasNodeName="")NativeGlobal- Sets havok material type. Use oldMaterial string to select what material you want to change from to (eg. from stone to wood), and nodeName to apply it to the specific node.
- If both are empty, every collision material will be set.
- Found in:
- PO3's PE
- Copies skin tint color from actorbase to bodypart nif
- Bodyparts nif must have skin shaders
- Found in:
- PO3's PE
voidfunctionSetShaderType(ObjectReferenceakRef, ObjectReferenceakTemplate, stringasDiffusePath, intaiShaderType, intaiTextureType, boolabNoWeapons, boolabNoAlphaProperty)NativeGlobalShader Types
Shader Value kDefault 0 kEnvironmentMap 1 kGlowMap 2 kParallax 3 kFaceGen 4 kFaceGenRGBTint 5 kHairTint 6 kParallaxOcc 7 kMultiTexLand 8 kLODLand 9 kMultilayerParallax 11 kTreeAnim 12 kMultiIndexTriShapeSnow 14 kLODObjectsHD 15 kEye 16 kCloud 17 kLODLandNoise 18 kMultiTexLandLODBlend 19 - Sets the ref's shader material type ie. Default to Cubemap
- If texture type is -1, the reference's entire textureset is replaced using the template's textureset;
- If texture type is 0-9 the template's textureset is still applied but reference's texture at that index will take priority.
- Optional diffuse path can be used to filter shapes to apply the shader to, partial matches are accepted like "Draugr.dds"
- Limitations - cannot be used on geometry with no normals (ie. body skin meshes)
- Found in:
- PO3's PE
- Stops ALL effect shaders and art objects (visual effects) currently on this actor
- Found in:
- PO3's PE
- Removes all instances of the art object (hit magic effect/visual effect) attached to the reference.
- Found in:
- PO3's PE
- Toggles node attached to root 3D.
- Found in:
- PO3's PE
voidfunctionUpdateHitEffectArtNode(ObjectReferenceakRef, ArtakArt, stringasNewNode, float[]afTranslate, float[]afRotate, floatafRelativeScale=1.0)NativeGlobal- Updates node data. Move hit effect art to new node (ie. from "MagicEffectsNode" to "NPC Head [Head]") or update translate, rotate, and scale values.
- Translate and Rotate arrays must have three values in order to work. Rotate uses euler angles in degrees (XYZ). Scale is relative, and is multiplied by existing scale.
- If the hit effect art is removed and reattached, it will revert back to the values in the nif.
- Found in:
- PO3's PE
Package Types
Package Type None -1 Explore 0 Follow 1 Escort 2 Eat 3 Sleep 4 Wander 5 Travel 6 Accompany 7 UseItemAt 8 Ambush 9 FleeNotCombat 10 CastMagic 11 Sandbox 12 Patrol 13 Guard 14 Dialogue 15 UseWeapon 16 Find 17 Package 18 PackageTemplate 19 Activate 20 Alarm 21 Flee 22 Trespass 23 Spectator 24 ReactToDead 25 GetUpFromChairBed 26 DoNothing 27 InGameDialogue 28 Surface 29 SearchForAttacker 30 AvoidPlayer 31 ReactToDestroyedObject 32 ReactToGrenadeOrMine 33 StealWarning 34 PickPocketWarning 35 MovementBlocked 36 VampireFeed 37 Cannibal 38 Landing 39 Unused 40 MountActor 41 DismountActor 42 ClearMountPosition 43 - Gets package type. Returns -1 if package is None
- Found in:
- PO3's PE
- Gets all idles on this package
- Found in:
- PO3's PE
- Adds idle to the end of the package idle stack, creating it if needed.
- Found in:
- PO3's PE
- Removes idle from package
- Found in:
- PO3's PE
(major,minor,patch / 5,10,0)
- Found in:
- PO3's PE
voidfunctionAddMagicEffectToPotion(PotionakPotion, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0, string[]asConditionList)NativeGlobal- Found in:
- PO3's PE
voidfunctionAddEffectItemToPotion(PotionakPotion, PotionakPotionToCopyFrom, intaiIndex, floatafCost=-1)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveMagicEffectFromPotion(PotionakPotion, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveEffectItemFromPotion(PotionakPotion, PotionakPotionToMatchFrom, intaiIndex)NativeGlobal- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Usually 0.0 for non arrow projectiles.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
Projectile Type None 0 Missile 1 Lobber 2 Beam 3 Flame 4 Cone 5 Barrier 6 Arrow 7 - Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
Sets the speed of the projectile set in the first parameter. (This function requires PowerOfThree's Papyrus Extender)
- Found in:
- PO3's PE
- Get all quest objective indices
- Found in:
- PO3's PE
- Get all quest stages
- Found in:
- PO3's PE
- Set quest objective text
- Found in:
- PO3's PE
- Get all actors in scene. Quest aliases must be filled.
- Found in:
- PO3's PE
- Found in:
- PO3's PE
voidfunctionAddMagicEffectToScroll(ScrollakScroll, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0, string[]asConditionList)NativeGlobal- Found in:
- PO3's PE
voidfunctionAddEffectItemToScroll(ScrollakScroll, ScrollakScrollToCopyFrom, intaiIndex, floatafCost=-1)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveMagicEffectFromScroll(ScrollakScroll, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0)NativeGlobal- Found in:
- PO3's PE
voidfunctionRemoveEffectItemFromScroll(ScrollakScroll, ScrollakScrollToMatchFrom, intaiIndex)NativeGlobal- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Sets sound descriptor associated with the sound.
- Found in:
- PO3's PE
Type Value None -1 Spell 0 Disease 1 Power 2 LesserPower 3 Ability 4 Poison 5 Enchantment 6 Potion 7 Ingredient 8 LeveledSpell 9 Addiction 10 Voice 11 - Returns spell type.
- Found in:
- PO3's PE
voidfunctionAddMagicEffectToSpell(SpellakSpell, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0, string[]asConditionList)NativeGlobal- Condition format :
ConditionItemObject | Function ID | parameter 1 | parameter 2 | OPCode | float | ANDOR - eg.
"Subject | HasMagicEffectKeyword | 0001EA6F ~ Skyrim.esm | NONE | == | 0.0 | AND" - Conditions which have no parameters (eg. IsSneaking) / take in forms (GetIsRace) work
- Conditions which accept int/float/strings are skipped
- Found in:
- PO3's PE
voidfunctionAddEffectItemToSpell(SpellakSpell, SpellakSpellToCopyFrom, intaiIndex, floatafCost=-1)NativeGlobal- Adds effectitem from spell to target spell, at given index. Same as above function, but less verbose, and preserves all conditions.
- Found in:
- PO3's PE
voidfunctionRemoveMagicEffectFromSpell(SpellakSpell, MagicEffectakMagicEffect, floatafMagnitude, intaiArea, intaiDuration, floatafCost=0.0)NativeGlobal- Removes magic effect from spell that matches magnitude/area/duration/cost.
- Found in:
- PO3's PE
voidfunctionRemoveEffectItemFromSpell(SpellakSpell, SpellakSpellToMatchFrom, intaiIndex)NativeGlobal- Removes effectitem from spell that matches spell at index.
- Found in:
- PO3's PE
- Sets casting type of spell (and all attached magic effects)
- See Casting Type for list of casting types
- Found in:
- PO3's PE
- Sets delivery type of spell (and all attached magic effects)
- See Delivery Type for list of delivery types
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Converts int to string. Integers exceeding
2147483647cannot be handled properly using Papyrus. abHexadds0xto the beginning of the string
- Found in:
- PO3's PE
- Converts string to int. Returns -1 for out of bound values.
- Found in:
- PO3's PE
- Gets the objectreference of the currently opened container in container menu
- Found in:
- PO3's PE
- Returns whether menus are visible (eg. check if menus are hidden using
tmconsole command)
- Found in:
- PO3's PE
- Found in:
- PO3's PE
- Display or hide
Sleep/Waitmenu
- Found in:
- PO3's PE
- Calculates a random float between afMin and afMax, based on Mersenne Twister
- Found in:
- PO3's PE
- Calculates a random integer between afMin and afMax, based on Mersenne Twister
- Found in:
- PO3's PE
Index Time Range 0 Year 1601 - 30827 1 Month 1-12 2 DayOfWeek 1:Sunday - 7:Saturday 3 Day 1-31 4 Hour 0-23 5 Minute 0-59 6 Second 0-59 7 Millisecond 0-999 - Found in:
- PO3's PE
- Gets the art object associated with the visual effect.
- Found in:
- PO3's PE
- Returns the total number of art objects present/active (on objects) within the loaded area.
- Found in:
- PO3's PE
- Sets the art object associated with the visual effect.
- Found in:
- PO3's PE
- Gets wind speed as shown as in CK conditions (0.0-1.0).
- Found in:
- PO3's PE
- Gets wind speed as shown in the weather form (0-255).
- Found in:
- PO3's PE
Type Value Pleasant 0 Cloudy 1 Rainy 2 Snow 3 - Gets weather/current weather type if akWeather is None