Function Libraries - lynnpye/sl_triggers GitHub Wiki

Function Libraries

SL Triggers ships with three "function libraries". Function libraries allow functions to be overridden to change or enhance functionality contextually. For example, util_waitforkbd will return at the end of a SexLab scene when SexLab is present, in addition to when one of the selected keys is present, as SexLab overrides the behavior.

As a result, some functions will appear twice. If it is in the SexLab section it is an override to the baseline functionality in the SLT library.

SLT Function Library (base functionality)

Actor

actor_advskill

Description Advance targeted actor's skill by specified amount. Only works on Player.

Parameters

actor: target Actor  
skill: skillname e.g. Alteration, Destruction  
value: number

Example

actor_advskill $self Alteration 1

Boost Alteration by 1 point
Note: Currently only works on PC/Player

actor_body

Description Alters or queries information about the actor's body, based on sub-function

Parameters

actor: target Actor  
sub-function: sub-function  
third argument: varies by sub-function

if parameter 2 is "ClearExtraArrows": clear extra arrows
if parameter 2 is "RegenerateHead": regenerate head
if parameter 2 is "GetWeight": get actors weight (0-100)
if parameter 2 is "SetWeight" (parameter 3: <float, weight>): set actors weight

Example

actor_body $self "SetWeight" 110

actor_doaction

Description For the targeted Actor, perform the associated function based on the specified action 'Action' in this case specifically refers to functions that take no parameters and return no values https://ck.uesp.net/wiki/Actor_Script

Parameters

actor: target Actor  (accepts special variable names ($self, $player) and both relative "Skyrim.esm:0f" and absolute "0f" values)  
action: action name

;;;; These are from Actor
ClearArrested
ClearExpressionOverride
ClearExtraArrows
ClearForcedLandingMarker
ClearKeepOffsetFromActor
ClearLookAt
DispelAllSpells
DrawWeapon
EndDeferredKill
EvaluatePackage
MakePlayerFriend
MoveToPackageLocation
RemoveFromAllFactions
ResetHealthAndLimbs
Resurrect
SendAssaultAlarm
SetPlayerResistingArrest
ShowBarterMenu
StartDeferredKill
StartSneaking
StopCombat
StopCombatAlarm
UnequipAll
UnlockOwnedDoorsInCell
;;;; will call objectreference_doaction if no matches are found

Example

actor_doaction $self StopCombat

actor_doconsumer

Description For the specified Actor, perform the requested consumer, provided the appropriate additional parameters 'Consumer' in this case specifically refers to functions that take parameters but return no result https://ck.uesp.net/wiki/Actor_Script

Parameters

actor: target Actor (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
consumer: consumer name

AddPerk
AddToFaction
AllowBleedoutDialogue
AllowPCDialogue
AttachAshPile
DamageActorValue
DamageAV
DoCombatSpellApply
EnableAI
EquipItem
EquipShout
EquipSpell
ForceActorValue
ForceAV
KeepOffsetFromActor
Kill
KillEssential
KillSilent
ModActorValue
ModAV
ModFactionRank
OpenInventory
PlaySubGraphAnimation
RemoveFromFaction
RemovePerk
RestoreActorValue
RestoreAV
SendTrespassAlarm
SetActorValue
SetAlert
SetAllowFlying
SetAllowFlyingEx
SetAlpha
SetAttackActorOnSight
SetAV
SetBribed
SetCrimeFaction
SetCriticalStage
SetDoingFavor
SetDontMove
SetExpressionOverride
SetEyeTexture
SetFactionRank
SetForcedLandingMarker
SetGhost
SetHeadTracking
SetIntimidated
SetLookAt
SetNoBleedoutRecovery
SetNotShowOnStealthMeter
SetOutfit
SetPlayerControls
SetPlayerTeammate
SetRace
SetRelationshipRank
SetRestrained
SetSubGraphFloatVariable
SetUnconscious
SetVehicle
SetVoiceRecoveryTime
StartCannibal
StartCombat
StartVampireFeed
UnequipItem
UnequipItemSlot
UnequipShout
UnequipSpell
SendLycanthropyStateChanged
SendVampirismStateChanged
EquipItemEx
EquipItemById
UnequipItemEx
ChangeHeadPart
ReplaceHeadPart
UpdateWeight

Example

set $newGhostStatus 1  
actor_doconsumer $self SetGhost $newGhostStatus

actor_dofunction

Description For the targeted Actor, set $$ to the result of the specified Function 'Function' in this case specifically refers to functions that take one or more parameters and return a value https://ck.uesp.net/wiki/Actor_Script

Parameters

actor: target Actor  (accepts special variable names ($self, $player) and both relative "Skyrim.esm:0f" and absolute "0f" values)  
function: function name

AddShout
AddSpell
DispelSpell
GetActorValue
GetActorValuePercentage
GetAV
GetAVPercentage
GetBaseActorValue
GetBaseAV
GetEquippedItemType
GetFactionRank
GetFactionReaction
GetRelationshipRank
HasAssociation
HasFamilyRelationship
HasLOS
HasMagicEffect
HasMagicEffectWithKeyword
HasParentRelationship
HasPerk
HasSpell
IsDetectedBy
IsEquipped
IsHostileToActor
IsInFaction
PathToReference
PlayIdle
PlayIdleWithTarget
RemoveShout
RemoveSpell
TrapSoul
WornHasKeyword
GetActorValueMax
GetAVMax
GetEquippedItemId
GetEquippedSpell
GetEquippedWeapon
GetEquippedArmorInSlot
GetWornForm
GetEquippedObject
GetNthSpell

Example

actor_dogetter

Description For the targeted Actor, set $$ to the result of the specified getter 'Getter' in this case specifically refers to functions that take no parameters but return a value https://ck.uesp.net/wiki/Actor_Script

Parameters

actor: target Actor  (accepts special variable names ($self, $player) and both relative "Skyrim.esm:0f" and absolute "0f" values)  
getter: getter name

;;;; These are from Actor
CanFlyHere
Dismount
GetActorBase
GetBribeAmount
GetCrimeFaction
GetCombatState
GetCombatTarget
GetCurrentPackage
GetDialogueTarget
GetEquippedShield
GetEquippedShout
GetFlyingState
GetForcedLandingMarker
GetGoldAmount
GetHighestRelationshipRank
GetKiller
GetLevel
GetLeveledActorBase
GetLightLevel
GetLowestRelationshipRank
GetNoBleedoutRecovery
GetPlayerControls
GetRace
GetSitState
GetSleepState
GetVoiceRecoveryTime
IsAlarmed
IsAlerted
IsAllowedToFly
IsArrested
IsArrestingTarget
IsBeingRidden - not a SexLab setting
IsBleedingOut
IsBribed
IsChild
IsCommandedActor
IsDead
IsDoingFavor
IsEssential
IsFlying
IsGhost
IsGuard
IsInCombat
IsInKillMove
IsIntimidated
IsOnMount - see IsBeingRidden
IsPlayersLastRiddenHorse - I don't even need to comment now, do I?
IsPlayerTeammate
IsRunning
IsSneaking
IsSprinting
IsTrespassing
IsUnconscious
IsWeaponDrawn
;;;; These are from SKSE
GetSpellCount
IsAIEnabled
IsSwimming
;;;; These are Special Edition exclusive
WillIntimidateSucceed
IsOverEncumbered
GetWarmthRating

Example

actor_dogetter CanFlyHere  
if $$ = 1 ICanFlyAroundHere  
if $$ = 0 IAmGroundedLikeAlways

actor_getfactionrank

Description Sets $$ to the actor's rank in the faction indicated by the FormId

Parameters

actor: target Actor  
faction: FACTION FormID

Example

actor_getfactionrank $actor "skyrim.esm:378958"

actor_getgender

Description Sets $$ to the actor's gender, 0 - male, 1 - female, 2 - creature, "" otherwise

Parameters

actor: target Actor

Example

actor_getgender $actor

actor_getrelation

Description Set $$ to the relationship rank between the two actors

Parameters

first actor: target Actor  
second actor: target Actor

Example

actor_getrelation $actor $player

4 - Lover
3 - Ally
2 - Confidant
1 - Friend
0 - Acquaintance
-1 - Rival
-2 - Foe
-3 - Enemy
-4 - Archnemesis

actor_getscale

Description Sets $$ to the 'scale' value of the specified Actor Note: this is properly a function of ObjectReference, so may get pushed to a different group at some point

Parameters

actor: target Actor

Example

actor_getscale $self  
msg_console "Scale reported: " $$

actor_haskeyword

Description Sets $$ to 1 if actor has the keyword, 0 otherwise.

Parameters

actor: target Actor  
keyword: string, keyword name

Example

actor_haskeyword $actor Vampire

actor_haslos

Description Set $$ to 1 if first actor can see second actor, 0 if not.

Parameters

first actor: target Actor  
second actor: target Actor

Example

actor_haslos $actor $self  
if $$ = 0 cannotseeme

actor_incskill

Description Increase targeted actor's skill by specified amount

Parameters

actor: target Actor  
skill: skillname e.g. Alteration, Destruction  
value: number

Example

actor_incskill $self Alteration 1

Boost Alteration by 1 point

actor_infaction

Description Sets $$ to 1 if actor is in the faction indicated by the FormId, 0 otherwise

Parameters

actor: target Actor  
faction: FACTION FormID

Example

actor_infaction $actor "skyrim.esm:378958"

$$ will be 1 if $actor is a follower (CurrentFollowerFaction)

actor_isaffectedby

Description Sets $$ to 1 if the specified actor is currently affected by the MGEF or SPEL indicated by FormID (accepts either)

Parameters

actor: target Actor  
(optional) "ALL": if specified, all following MGEF or SPEL FormIDs must be found on the target Actor  
magic effect or spell: MGEF or SPEL FormID [<MGEF or SPEL FormID> <MGEF or SPEL FormID> ...]

Example

actor_isaffectedby $actor "skyrim.esm:1030541"  
actor_isaffectedby $actor "skyrim.esm:1030541" "skyrim.esm:1030542" "skyrim.esm:1030543"  
actor_isaffectedby $actor ALL "skyrim.esm:1030541" "skyrim.esm:1030542" "skyrim.esm:1030543"

actor_isguard

Description Sets $$ to 1 if actor is guard, 0 otherwise.

Parameters

actor: target Actor

Example

actor_isguard $actor

actor_isplayer

Description Sets $$ to 1 if actor is the player, 0 otherwise.

Parameters

actor: target Actor

Example

actor_isplayer $actor

actor_isvalid

Description Set $$ to 1 if actor is valid, 0 if not.

Parameters

actor: target Actor

Example

actor_isvalid $actor  
if $$ = 0 end  
...  
[end]

Jump to the end if actor is not valid

actor_iswearing

Description Sets $$ to 1 if actor is wearing the armor indicated by the FormId, 0 otherwise.

Parameters

actor: target Actor  
armor: ARMO FormID

Example

actor_iswearing $actor "petcollar.esp:31017"

actor_lochaskeyword

Description Sets $$ to 1 if actor's current location has the indicated keyword, 0 otherwise.

Parameters

actor: target Actor  
keyword: string, keyword name

Example

actor_lochaskeyword $actor "LocTypeInn"

In a bar, inn, or tavern

actor_modcrimegold

Description Specified actor reports player, increasing bounty by specified amount.

Parameters

actor: target Actor  
bounty: number

Example

actor_modcrimegold $actor 100

actor_name

Description Set $$ to the actor name

Parameters

actor: target Actor

Example

actor_name $actor

actor_name

Description Set $$ to the actor displayName

Parameters

actor: target Actor

Example

actor_display_name $actor

actor_playanim

Description Causes the actor to play the specified animation

Parameters

actor: target Actor  
animation: animation name

Example

actor_playanim $self "IdleChildCryingStart"

actor_qnnu

Description Repaints actor (calls QueueNiNodeUpdate)

Parameters

actor: target Actor

Example

actor_qnnu $actor

Note: Do not call this too frequently as the rapid refreshes can causes crashes to desktop

actor_race

Description Sets $$ to the race name based on sub-function. Blank, empty sub-function returns Vanilla racenames. e.g. "SL" can return SexLab race keynames.

Parameters

actor: target Actor  
sub-function: sub-function

if parameter 2 is "": return actors race name. Skyrims, original name. Like: "Nord", "Breton"

Example

actor_race $self ""

actor_removefaction

Description Removes the actor from the specified faction

Parameters

actor: target Actor  
faction: FACTION FormID

Example

actor_removefaction $actor "skyrim.esm:3505"

actor_say

Description Causes the actor to 'say' the topic indicated by FormId; not usable on the Player

Parameters

actor: target Actor  
topic: TOPIC FormID

Example

actor_say $actor "Skyrim.esm:1234"

actor_sendmodevent

Description Causes the actor to send the mod event with the provided arguments

Parameters

actor: target Actor  
event: name of the event  
string arg: string argument (meaning varies by event sent) (optional: default "")  
float arg: float argument (meaning varies by event sent) (optional: default 0.0)

Example

actor_sendmodevent $self "IHaveNoIdeaButEventNamesShouldBeEasyToFind" "strarg" 20.0

actor_setalpha

Description Set the Actor's alpha value (inverse of transparency, 1.0 is fully visible) (has no effect if IsGhost() returns true)

Parameters

actor: target Actor  
alpha: 0.0 to 1.0 (higher is more visible)  
fade: 0 - instance | 1 - fade to the new alpha gradually (optional: default 1 - fade)

Example

actor_setalpha $self 0.5 1

$self will fade to new alpha of 0.5, not instantly

actor_setfactionrank

Description Sets the actor's rank in the faction indicated by the FormId to the indicated rank

Parameters

actor: target Actor  
faction: FACTION FormID  
rank: number

Example

actor_setfactionrank $actor "skyrim.esm:378958" -1

actor_setrelation

Description Set relationship rank between the two actors to the indicated value

Parameters

first actor: target Actor  
second actor: target Actor  
rank: number

Example

actor_setrelation $actor $player 0

See actor_getrelation for ranks

actor_setscale

Description Sets the actor's scale to the specified value Note: this is properly a function of ObjectReference, so may get pushed to a different group at some point

Parameters

actor: target Actor  
scale: float, new scale value to replace the old

Example

actor_setscale $self 1.01

actor_state

Description Returns the state of the actor for a given sub-function

Parameters

actor: target Actor  
sub-function: sub-function  
third argument: varies by sub-function

if parameter 2 is "GetCombatState": return actors combatstate. 0-no combat, 1-combat, 2-searching
if parameter 2 is "GetLevel": return actors level
if parameter 2 is "GetSleepState": return actors sleep mode. 0-not, 1-not, but wants to, 2-sleeping, 3-sleeping, but wants to wake up
if parameter 2 is "IsAlerted": is actor alerted
if parameter 2 is "IsAlarmed": is actor alerted
if parameter 2 is "IsPlayerTeammate": is actor PC team member
if parameter 2 is "SetPlayerTeammate" (parameter 3: <bool true to set, false to unset>): set actor as PC team member
if parameter 2 is "SendAssaultAlarm": actor will send out alarm

Example

actor_state $self "GetCombatState"

actor_wornhaskeyword

Description Sets $$ to 1 if actor is wearing any armor with indicated keyword, 0 otherwise.

Parameters

actor: target Actor  
keyword: string, keyword name

Example

actor_wornhaskeyword $actor "VendorItemJewelry"

actor_worninslot

Description Sets $$ to 1 if actor is wearing armor in the indicated slotId, 0 otherwise.

Parameters

actor: target Actor  
armorslot: number, e.g. 32 for body slot

Example

actor_worninslot $actor 32

Actor Value

av_damage

Description Damage actor value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health  
amount: amount to damage

Example

av_damage $self Health 100  
av_damage $self   $3   100 ;where $3 might be "Health"

Damages Health by 100. This can result in death.

av_get

Description Set $$ to the actor's current value for the specified Actor Value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health

Example

av_get $self Health

Sets the actor's current Health into $$

av_getbase

Description Sets $$ to the actor's base value for the specified Actor Value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health

Example

av_getbase $self Health

Sets the actor's base Health into $$

av_getmax

Description Set $$ to the actor's max value for the specified Actor Value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health

Example

av_get $self Health

Sets the actor's max Health into $$

av_getpercentage

Description Set $$ to the actor's value as a percentage of max for the specified Actor Value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health

Example

av_getpercentage $self Health

Sets the actor's percentage of Health remaining into $$

av_mod

Description Modify actor value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health  
amount: amount to modify by

Example

av_mod $self Health 100  
av_mod $self   $3   100 ;where $3 might be "Health"

Changes the max value of the actor value. Not the same as restore/damage.

av_restore

Description Restore actor value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health  
amount: amount to restore

Example

av_restore $self Health 100  
av_restore $self   $3   100 ;where $3 might be "Health"

Restores Health by 100 e.g. healing

av_set

Description Set actor value

Parameters

actor: target Actor  
av name: Actor Value name e.g. Health  
amount: amount to modify by

Example

av_set $self Health 100  
av_set $self   $3   100 ;where $3 might be "Health"

Sets the value of the actor value.

Form

form_consumer

Description For the specified Form, perform the requested consumer, provided the appropriate additional parameters 'Consumer' in this case specifically refers to functions that take parameters but return no result https://ck.uesp.net/wiki/Form_Script

Parameters

form: target Form (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
consumer: consumer name

SetPlayerKnows
SetWorldModelPath
SetName
SetWeight
SetGoldValue
SendModEvent

Example

actor_dogetter GetEquippedShield  
set $shieldFormID $$  
form_consumer $shieldFormID SetWeight 0.1 ; featherweight shield

form_doaction

Description For the targeted Form, perform the associated function based on the specified action 'Action' in this case specifically refers to functions that take no parameters and return no values https://ck.uesp.net/wiki/Form_Script

Parameters

form: target Form (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
action: action name

;;;; These are from Form
RegisterForSleep
RegisterForTrackedStatsEvent
StartObjectProfiling
StopObjectProfiling
UnregisterForSleep
UnregisterForTrackedStatsEvent
UnregisterForUpdate
UnregisterForUpdateGameTime
;;;; These are from SKSE
UnregisterForAllKeys
UnregisterForAllControls
UnregisterForAllMenus
RegisterForCameraState
UnregisterForCameraState
RegisterForCrosshairRef
UnregisterForCrosshairRef
RegisterForNiNodeUpdate
UnregisterForNiNodeUpdate

Example

form_doaction $self StopCombat

form_dofunction

Description For the targeted Form, set $$ to the result of the specified function 'Function' in this case specifically refers to functions that take one or more parameters and return a value https://ck.uesp.net/wiki/Form_Script

Parameters

actor: target Form  (accepts special variable names ($self, $player) and both relative "Skyrim.esm:0f" and absolute "0f" values)  
function: function name

HasKeywordString
HasKeyword
GetNthKeyword
GetWorldModelNthTextureSet

form_dogetter

Description For the targeted Actor, set $$ to the result of the specified getter 'Getter' in this case specifically refers to functions that take no parameters but return a value https://ck.uesp.net/wiki/Form_Script

Parameters

form: target Form (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
getter: getter name

;;;; T79686hese are from Form
GetFormID
GetGoldValue
PlayerKnows
;;;; These are from SKSE
GetType
GetName
GetWeight
GetNumKeywords
IsPlayable
HasWorldModel
GetWorldModelPath
GetWorldModelNumTextureSets
TempClone

Example

form_dogetter IsPlayable  
if $$ = 1 itwasplayable

Imagespace Modifier

ism_applyfade

Description Apply imagespace modifier - per original author, check CreationKit, SpecialEffects\Imagespace Modifier

Parameters

item: ITEM FormID  
duration: fade duration in seconds

Example

ism_applyfade $1 2

ism_removefade

Description Remove imagespace modifier - per original author, check CreationKit, SpecialEffects\Imagespace Modifier

Parameters

item: ITEM FormID  
duration: fade duration in seconds

Example

ism_removefade $1 2

Items

item_add

Description Adds the item to the actor's inventory.

Parameters

actor: target Actor  
item: ITEM FormId  
count: number (optional: default 1)  
displaymessage: 0 - show message | 1 - silent (optional: default 0 - show message)

Example

item_add $self "skyrim.esm:15" 10 0

Adds 10 gold to the actor, displaying the notification

item_addex

Description Adds the item to the actor's inventory, but check if some armor was re-equipped (if NPC)

Parameters

actor: target Actor  
item: ITEM FormId  
count: number (optional: default 1)  
displaymessage: 0 - show message | 1 - silent (optional: default 0 - show message)

Example

item_addex $self "skyrim.esm:15" 10 0

item_adduse

Description Add item (like item_add) and then use the added item. Useful for potions, food, and other consumables.

Parameters

actor: target Actor  
item: ITEM FormId  
count: number (optional: default 1)  
displaymessage: 0 - show message | 1 - silent (optional: default 0 - show message)

Example

item_adduse $self "skyrim.esm:216158" 1 0

Add and drink some booze

item_equip

Description Equip item ("vanilla" version)

Parameters

actor: target Actor  
item: ITEM FormId  
removalallowed: 0 - removal allowed | 1 - removal not allowed  
sound: 0 - no sound | 1 - with sound  
<actor variable> <ITEM FormId> <0 - removal allowed | 1 - removal not allowed> <0 - no sound | 1 - with sound>

Example

item_equip $self "ZaZAnimationPack.esm:159072" 1 0

Equip the ZaZ armor on $self, silently, with no removal allowed (uses whatever slot the armor uses)

item_equipex

Description Equip item (SKSE version)

Parameters

actor: target Actor  
item: ITEM FormId  
armorslot: number e.g. 32 for body slot  
sound: 0 - no sound | 1 - with sound  
removalallowed: 0 - removal allowed | 1 - removal not allowed

Example

item_equipex $self "ZaZAnimationPack.esm:159072" 32 0 1

Equip the ZaZ armor on $self, at body slot 32, silently, with no removal allowed
Equips item directly, Workaround for "NPCs re-equip all armor, if they get an item that looks like armor"

item_getcount

Description Set $$ to how many of a specified item an actor has

Parameters

actor: target Actor  
item: ITEM FormId

Example

item_getcount $self "skyrim.esm:15"

item_remove

Description Remove the item from the actor's inventory

Parameters

actor: target Actor  
item: ITEM FormId  
count: number  
displaymessage: 0 - show message | 1 - silent (optional: default 0 - show message)

Example

item_remove $self "skyrim.esm:15" 10 0

Removes up to 10 gold from the actor

item_unequipex

Description Unequip item

Parameters

actor: target Actor  
item: ITEM FormId  
armorslot: number e.g. 32 for body slot

Example

item_unequipex $self "ZaZAnimationPack.esm:159072" 32

Unequips the ZaZ armor from slot 32 on $self

JSON

json_getvalue

Description Sets $$ to value from JSON file (uses PapyrusUtil/JsonUtil)

Parameters

filename: name of file, rooted from 'Data/SKSE/Plugins/sl_triggers'  
datatype: int, float, string  
key: the key  
default: default value in case it isn't present (optional: default for type)

Example

json_getvalue "../somefolder/afile" float "demofloatvalue" 2.3

JsonUtil automatically appends .json when not given a file extension

json_save

Description Tells JsonUtil to immediately save the specified file from cache

Parameters

filename: name of file, rooted from 'Data/SKSE/Plugins/sl_triggers'

Example

json_save "../somefolder/afile"

json_setvalue

Description Sets a value in a JSON file (uses PapyrusUtil/JsonUtil)

Parameters

filename: name of file, rooted from 'Data/SKSE/Plugins/sl_triggers'  
datatype: int, float, string  
key: the key  
new value: value to set

Example

json_setvalue "../somefolder/afile" float "demofloatvalue" 2.3

JsonUtil automatically appends .json when not given a file extension

MfgFix

mfg_getphonememodifier

Description Return facial expression (requires MfgFix https://www.nexusmods.com/skyrimspecialedition/mods/11669)

Parameters

actor: target Actor  
mode: number, 0 - set phoneme | 1 - set modifier  
id: an id (I'm not familiar with MfgFix :/)

Example

mfg_getphonememodifier $self 0 $1

mfg_reset

Description Resets facial expression (requires MfgFix https://www.nexusmods.com/skyrimspecialedition/mods/11669)

Parameters

actor: target Actor

Example

mfg_reset $self

mfg_setphonememodifier

Description Set facial expression (requires MfgFix https://www.nexusmods.com/skyrimspecialedition/mods/11669)

Parameters

actor: target Actor  
mode: number, 0 - set phoneme | 1 - set modifier  
id: an id  (I'm not familiar with MfgFix :/)  
value: int  
<actor variable> <mode> <id> <value>

Example

mfg_setphonememodifier $self 0 $1 $2

ObjectReference

objectreference_doaction

Description For the targeted ObjectReference, perform the associated function based on the specified action 'Action' in this case specifically refers to functions that take no parameters and return no values https://ck.uesp.net/wiki/ObjectReference_Script

Parameters

objectreference: target ObjectReference  (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
action: action name

;;;; These are from ObjectReference
ClearDestruction
Delete
DeleteWhenAble
ForceAddRagdollToWorld
ForceRemoveRagdollFromWorld
InterruptCast
MoveToMyEditorLocation
RemoveAllInventoryEventFilters
StopTranslation
;;;; These are from SKSE
ResetInventory
;;;; will call form_doaction if no matches are found

Example

objectreference_doaction $self StopCombat

objectreference_doconsumer

Description For the specified ObjectReference, perform the requested consumer, provided the appropriate additional parameters 'Consumer' in this case specifically refers to functions that take parameters but return no result https://ck.uesp.net/wiki/ObjectReference_Script

Parameters

objectreference: target ObjectReference (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
consumer: consumer name

Activate
AddInventoryEventFilter
AddItem
AddKeyIfNeeded
AddToMap
ApplyHavokImpulse
BlockActivation
CreateDetectionEvent
DamageObject
Disable
DisableLinkChain
DisableNoWait
DropObject
Enable
EnableFastTravel
EnableLinkChain
EnableNoWait
IgnoreFriendlyHits
KnockAreaEffect
Lock
MoveTo
MoveToInteractionLocation
MoveToNode
PlayTerrainEffect
ProcessTrapHit
PushActorAway
RemoveAllItems
RemoveInventoryEventFilter
RemoveItem
Reset
Say
SendStealAlarm
SetActorCause
SetActorOwner
SetAngle
SetAnimationVariableBool
SetAnimationVariableFloat
SetAnimationVariableInt
SetDestroyed
SetFactionOwner
SetLockLevel
SetMotionType
SetNoFavorAllowed
SetOpen
SetPosition
SetScale
SplineTranslateTo
SplineTranslateToRef
SplineTranslateToRefNode
TetherToHorse
TranslateTo
TranslateToRef
SetHarvested
SetItemHealthPercent
SetItemMaxCharge
SetItemCharge
SetEnchantment
CreateEnchantment

Example

actor_dogetter GetEquippedShield  
set $shieldFormID $$  
objectreference_doconsumer $shieldFormID CreateEnchantment 200.0 "Skyrim.esm:form-id-for-MGEF" 20.0 0.0 30.0

objectreference_dofunction

Description For the targeted ObjectReference, set $$ to the result of the specified function 'Function' in this case specifically refers to functions that take one or more parameters and return a value https://ck.uesp.net/wiki/ObjectReference_Script

Parameters

actor: target ObjectReference  (accepts special variable names ($self, $player) and both relative "Skyrim.esm:0f" and absolute "0f" values)  
function: function name

CalculateEncounterLevel
CountLinkedRefChain
GetAnimationVariableBool
GetAnimationVariableFloat
GetAnimationVariableInt
GetDistance
GetHeadingAngle
GetItemCount
HasEffectKeyword
HasNode
HasRefType
IsActivateChild
IsFurnitureInUse
IsFurnitureMarkerInUse
IsInLocation
MoveToIfUnloaded
PlayAnimation
PlayAnimationAndWait
PlayGamebryoAnimation
PlayImpactEffect
PlaySyncedAnimationAndWaitSS
PlaySyncedAnimationSS
RampRumble
WaitForAnimationEvent
SetDisplayName
GetNthForm
PlaceActorAtMe
PlaceAtMe
GetLinkedRef
GetNthLinkedRef

objectreference_dogetter

Description For the targeted ObjectReference, set $$ to the result of the specified getter 'Getter' in this case specifically refers to functions that take no parameters but return a value https://ck.uesp.net/wiki/ObjectReference_Script

Parameters

objectreference: target ObjectReference  (accepts both relative "Skyrim.esm:0f" and absolute "0f" values)  
getter: getter name

;;;; These are from ObjectReference
CanFastTravelToMarker
GetActorOwner
GetAngleX
GetAngleY
GetAngleZ
GetBaseObject
GetCurrentDestructionStage
GetCurrentLocation
GetCurrentScene
GetEditorLocation
GetFactionOwner
GetHeight
GetItemHealthPercent
GetKey
GetLength
GetLockLevel
GetMass
GetOpenState
GetParentCell
GetPositionX
GetPositionY
GetPositionZ
GetScale
GetTriggerObjectCount
GetVoiceType
GetWidth
GetWorldSpace
IsActivationBlocked
Is3DLoaded
IsDeleted
IsDisabled
IsEnabled
IsIgnoringFriendlyHits
IsInDialogueWithPlayer
IsInInterior
IsLocked
IsMapMarkerVisible
IsNearPlayer
;;;; These are from SKSE
GetNumItems
GetTotalItemWeight
GetTotalArmorWeight
IsHarvested
GetItemMaxCharge
GetItemCharge
IsOffLimits
GetDisplayName
GetEnableParent
GetEnchantment
GetNumReferenceAliases

Example

actor_dogetter CanFlyHere  
if $$ = 1 ICanFlyAroundHere  
if $$ = 0 IAmGroundedLikeAlways

PapyrusUtil

jsonutil

Description Wrapper around most JsonUtil functions

Parameters

<sub-function> - JsonUtil functionality to perform  
<filename> - JSON file to interact with

Valid sub-functions are:
load :
save :
ispendingsave :
isgood :
geterrors :
exists :
unload : [saveChanges: 0 - false | 1 - true] [minify: 0 - false | 1 - true]
set : <type: int | float | string>
get : <type: int | float | string> []
unset : <type: int | float | string>
has : <type: int | float | string>
adjust : <type: int | float>
listadd : <type: int | float | string>
listget : <type: int | float | string>
listset : <type: int | float | string>
listremoveat : <type: int | float | string>
listinsertat : <type: int | float | string>
listclear : <type: int | float | string>
listcount : <type: int | float | string>
listcountvalue : <type: int | float | string> [<exclude: 0 - false | 1 - true>]
listfind : <type: int | float | string>
listhas : <type: int | float | string>
listresize : <type: int | float | string> []

storageutil

Description Wrapper around most StorageUtil functions

Parameters

<sub-function> - StorageUtil functionality to perform  
<form identifier> - object to interact with; see below for details
- represents the object you want StorageUtil activity keyed to StorageUtil accepts 'none' (null) to represent "global" StorageUtil space For SLTScript purposes, any identifier that will resolve to a Form object can be used Or you may specify the empty string ("") for the global space For example, any of the following might be valid: $self, $player, $actor ; these all resolve to Actor "sl_triggers.esp:3426" ; the FormID for the main Quest object for sl_triggers Read more about StorageUtil for more details Valid sub-functions are: set : get : [] pluck : [] unset : has : adjust : listadd : listget : listpluck : listset : listremoveat : listinsertat : listadjust : listclear : listpop : listshift : listsort : listcount : listcountvalue : [] listfind : listhas : listresize : []

Perks

perk_add

Description Add specified perk to the targeted actor

Parameters

perk: PERK FormID  
actor: target Actor

Example

perk_add "skyrim.esm:12384" $self

perk_addpoints

Description Add specified number of perk points to player

Parameters

perkpointcount: number of perk points to add

Example

perk_addpoints 4

perk_remove

Description Remove specified perk from the targeted actor

Parameters

perk: PERK FormID  
actor: target Actor

Example

perk_remove "skyrim.esm:12384" $self

Sound

snd_play

Description Return the sound instance handle from playing the specified audio from the specified actor

Parameters

audio: AUDIO FormID  
actor: target Actor

Example

snd_play "skyrim.esm:318128" $self

snd_setvolume

Description Set the sound volume using the specified sound instance handle (from snd_play)

Parameters

handle: sound instance handle from snd_play  
actor: target Actor  
volume: 0.0 - 1.0

Example

snd_setvolume $1 0.5

Set the volume of the audio sound playing with handle stored in $1 to 50%

snd_stop

Description Stops the audio specified by the sound instance handle (from snd_play)

Parameters

handle: sound instance handle from snd_play

Example

snd_stop $1

Spells

spell_add

Description Adds the specified SPEL by FormId to the targeted Actor, usually to add as an available power or spell in the spellbook.

Parameters

spell: SPEL FormId  
actor: target Actor

Example

spell_add "skyrim.esm:275236" $self

The light spell is now in the actor's spellbook

spell_cast

Description Cast spell at target

Parameters

spell: SPEL FormID  
actor: target Actor

Example

spell_cast "skyrim.esm:275236" $self

Casts light spell on self

spell_dcsa

Description Casts spell with DoCombatSpellApply Papyrus function. It is usually used for spells that are part of a melee attack (like animals that also carry poison or disease).

Parameters

spell: SPEL FormId  
actor: target Actor

Example

spell_dcsa "skyrim.esm:275236" $self

spell_dispel

Description Dispels specified SPEL by FormId from targeted Actor

Parameters

spell: SPEL FormId  
actor: target Actor

Example

spell_dispel "skyrim.esm:275236" $self

If light was currently on $self, it would now be dispelled

spell_remove

Description Removes the specified SPEL by FormId from the targeted Actor, usually to remove as an available power or spell in the spellbook.

Parameters

spell: SPEL FormId  
actor: target Actor

Example

spell_remove "skyrim.esm:275236" $self

The light spell should no longer be in the actor's spellbook

Utility

console

Description Executes the console command (requires a ConsoleUtil variant installed Recommend ConsoleUtil-Extended https://www.nexusmods.com/skyrimspecialedition/mods/133569)

Parameters

actor: target Actor  
command: <command fragment> [<command fragment> ...] ; all <command fragments> will be concatenated

Example

console $self "sgtm" "" "0.5"  
console $self "sgtm 0.5"

Both are the same

deb_msg

Description Joins all arguments together and adds the text to SKSE\Plugins\sl_triggers\debugmsg.log Text is always appended to the log, so if you use this, it will only grow in size until you truncate it.

Parameters

message: <msg> [<msg> <msg> ...]

Example

deb_msg "Hello" "world!"  
deb_msg "Hello world!"

Both do the same thing

math

Description Return values from math operations based on sub-function

Parameters

sub-function: sub-function  
variable: variable 3 varies by sub-function

if parameter 2 1s "asint": return parameter 3 as integer
if parameter 2 1s "floor": return parameter 3 the largest integer less than or equal to the value
if parameter 2 1s "ceiling": return parameter 3 the smallest integer greater than or equal to the value
if parameter 2 1s "abs": return parameter 3 as absolute value of the passed in value - N for N, and N for (-N)
if parameter 2 1s "toint": return parameter 3 as integer. Parameter 3 can be in dec or hex. If it starts with 0, its converted as hex value

Example

math floor 1.2

msg_console

Description Display the message in the console

Parameters

message: <msg> [<msg> <msg> ...]

Example

msg_console "Hello" "world!"  
msg_console "Hello world!"

Both are the same

msg_notify

Description Display the message in the standard notification area (top left of your screen by default)

Parameters

message: <msg> [<msg> <msg> ...]

Example

msg_notify "Hello" "world!"  
msg_notify "Hello world!"

Both are the same

rnd_int

Description Sets $$ to a random integer between min and max inclusive

Parameters

min: number  
max: number

Example

rnd_int 1 100

rnd_list

Description Sets $$ to one of the arguments at random

Parameters

arguments: <argument> <argument> [<argument> <argument> ...]

Example

rnd_list "Hello" $2 "Yo"

$$ will be one of the values. $2 will be resolved to it's value before populating $$

util_game

Description Perform game related functions based on sub-function

Parameters

sub-function: sub-function  
parameter: varies by sub-function

if sub-function is "IncrementStat", (parameter 3, , parameter 4, ), see https://ck.uesp.net/wiki/IncrementStat_-_Game
if sub-function is "QueryStat", (parameter 3, ), returns the value

Example

util_game "IncrementStat" "Bribes" 1

util_getgametime

Description Sets $$ to the value of Utility.GetCurrentGameTime() (a float value representing the number of days in game time; mid-day day 2 is 1.5)

Example

util_getgametime

util_getgametime

Description Sets $$ to the in-game hour (i.e. 2:30 AM returns 2)

Example

util_getgametime

util_getrandomactor

Description Sets $iterActor to a random actor within specified range of self

Parameters

range: 0 - all | >0 skyrim units

Example

util_getrandomactor 320

util_getrealtime

Description Sets $$ to the value of Utility.GetCurrentRealTime() (a float value representing the number of seconds since Skyrim.exe was launched this session)

Example

util_getrealtime

util_sendevent

Description Send SKSE custom event, with each type/value pair being an argument to the custom event

Parameters

event: name of the event  
(type/value pairs are optional; this devolves to util_sendmodevent <eventname>, though with such a call the event signature would require having no arguments)  
param type: type of parameter e.g. "bool", "int", etc.  
param value: value of parameter  
[type/value, type/value ...]

can be any of [bool, int, float, string, form]

Example

util_sendevent "slaUpdateExposure" form $self float 33

The "slaUpdateExposure" event will be sent with $self, and the float value of 33.0 as the two arguments

util_sendmodevent

Description Shorthand for actor_sendmodevent $player

Parameters

event: name of the event  
string arg: string argument (meaning varies by event sent) (optional: default "")  
float arg: float argument (meaning varies by event sent) (optional: default 0.0)

Example

util_sendmodevent "IHaveNoIdeaButEventNamesShouldBeEasyToFind" "strarg" 0.0

util_wait

Description Wait specified number of seconds i.e. Utility.Wait()

Parameters

duration: float, seconds

Example

util_wait 2.5

The script will pause processing for 2.5 seconds

util_waitforkbd

Description Sets $$ to the keycode pressed after waiting for user to press any of the specified keys

Parameters

dxscancode: <DXScanCode of key> [<DXScanCode of key> ...]

Example

util_waitforkbd 74 78 181 55

weather_state

Description Weather related functions based on sub-function

Parameters

<sub-function> ; currently only GetClassification

Example

weather_state GetClassification

SexLab Function Library (only functional if SexLab is present)

Actor

actor_race

Description Returns the race name based on sub-function. Blank, empty sub-function returns Vanilla racenames. e.g. "SL" can return SexLab race keynames.

Parameters

actor: target Actor  
sub-function: sub-function

if parameter 2 is "": return actors race name. Skyrims, original name. Like: "Nord", "Breton"
if parameter 2 is "SL": return actors Sexlab frameworks race key name. Like: "dogs", "bears", etc. Note: will return "" if actor is humanoid

Example

actor_race $self "SL"  
msg_notify "  Race SL: " $$

Devious Devices

dd_unlockall

Description Attempts to unlock all devices locked on the actor

Parameters

actor: target Actor  
force: "force" to force an unlock, anything else otherwise

Example

dd_unlockall $self force

Will attempt to (forcibly if necessary, e.g. quest locked items) unlock all lockable items on targeted actor.

dd_unlockslot

Description Attempts to unlock any device in the specified slot

Parameters

actor: target Actor  
armorslot: int value armor slot e.g. 32 is body armor  
force: "force" to force an unlock, anything else otherwise

Example

dd_unlockslot $self 32 force

Should remove anything in body slot e.g. corset, harness, etc., and forced, so including quest items (be careful!)

Devious Followers

df_resetall

Description Resets all Devious Followers values (i.e. quest states, deal states, boredom, debt) back to values as if having just started out.

Example

df_resetall

Should be free of all debts, deals, and rules

df_setdebt

Description Sets current debt to the specified amount

Parameters

newdebt: new debt value

Example

df_setdebt 0

We all know what you are going to use it for

OSLAroused

osla_get_actor_days_since_last_orgasm

Description Sets $$ to the result of OSLAroused_ModInterface.GetArousal()

Parameters

actor: target Actor

Example

osla_get_actor_days_since_last_orgasm $self  
msg_console "Arousal is: " $$

osla_get_arousal

Description Sets $$ to the result of OSLAroused_ModInterface.GetArousal()

Parameters

actor: target Actor

Example

osla_get_arousal $self  
msg_console "Arousal is: " $$

osla_get_arousal_multiplier

Description Sets $$ to the result of OSLAroused_ModInterface.GetArousal()

Parameters

actor: target Actor

Example

osla_get_arousal_multiplier $self  
msg_console "Arousal multiplier is: " $$

osla_get_exposure

Description Sets $$ to the result of OSLAroused_ModInterface.GetArousal()

Parameters

actor: target Actor

Example

osla_get_exposure $self  
msg_console "Exposure is: " $$

osla_modify_arousal

Description Sets $$ to the result of OSLAroused_ModInterface.ModifyArousal(Actor, float, string)

Parameters

actor: target Actor  
value: float value  
reason: string, optional (default "unknown")

Example

osla_modify_arousal $self 20.0 "for reasons"

osla_modify_arousal_multiplier

Description Sets $$ to the result of OSLAroused_ModInterface.ModifyArousalMultiplier(Actor, float, string)

Parameters

actor: target Actor  
value: float value  
reason: string, optional (default "unknown")

Example

osla_modify_arousal_multiplier $self 0.5 "for reasons"

osla_set_arousal

Description Sets $$ to the result of OSLAroused_ModInterface.SetArousal(Actor, float, string)

Parameters

actor: target Actor  
value: float value  
reason: string, optional (default "unknown")

Example

osla_set_arousal $self 50.0 "for reasons"

osla_set_arousal_multiplier

Description Sets $$ to the result of OSLAroused_ModInterface.SetArousalMultiplier(Actor, float, string)

Parameters

actor: target Actor  
value: float value  
reason: string, optional (default "unknown")

Example

osla_set_arousal_multiplier $self 2.0 "for reasons"

SexLab

sl_advance

Description Changes the stage of the current SexLab scene, for the target Actor; advances a single stage if positive, reverses a single stage if negative

Parameters

direction: integer, <negative - backwards / non-negative (including zero) - forwards>  
actor: target Actor

Example

sl_advance -3 $self

Only goes back one stage

sl_animname

Description Sets $$ to the current SexLab animation name

Example

sl_animname $self  
msg_notify "Playing: " $$

sl_getprop

Description Sets $$ to the value of the requested property

Parameters

property:  Stage | ActorCount  
actor: target Actor

Example

sl_getprop Stage $self  
msg_notify "Current Stage: " $$

sl_getrndactor

Description Return a random actor within specified range of self

Parameters

range: (0 - all | >0 - range in Skyrim units)  
option: (0 - all | 1 - not in SexLab scene | 2 - must be in SexLab scene) (optional: default 0 - all)

Example

sl_getrndactor 500 2  
actor_isvalid $actor  
if $$ = 0 end  
msg_notify "Someone is watching you!"  
[end]

sl_hastag

Description Sets $$ to 1 if the SexLab scene has the specified tag, 0 otherwise

Parameters

tag: tag name e.g. "Oral", "Anal", "Vaginal"  
actor: target Actor

Example

sl_hastag "Oral" $self  
if $$ = 1 ORAL

sl_isin

Description Sets $$ to 1 if the specified actor is in a SexLab scene, 0 otherwise

Parameters

actor: target Actor

Example

sl_isin $self

sl_isinslot

Description Sets $$ to 1 if the specified actor is in the specified SexLab scene slot, 0 otherwise

Parameters

actor: target Actor  
slotnumber: 1-based SexLab thread slot number

Example

sl_isinslot $player 1

sl_orgasm

Description Immediately forces the specified actor to have a SexLab orgasm.

Parameters

actor: target Actor

Example

sl_orgasm $self  
sl_orgasm $partner

Simultaneous orgasms

util_waitforend

Description Wait until specified actor is not in SexLab scene

Parameters

actor: target Actor

Example

util_waitforend $self

Wait until the scene ends

SexLab Separate Orgasms

slso_bonus_enjoyment

Description Applies BonusEnjoyment to the specified actor

Parameters

actor: target Actor  
enjoyment: int, 1-100?

Example

slso_bonus_enjoyment $self 30

Utility

util_waitforkbd

Description Returns the keycode pressed after waiting for user to press any of the specified keys or for the end of the SexLab scene

Parameters

actor: target Actor  
dxscancode: DXScanCode of key [<DXScanCode of key> ...]

Example

util_waitforkbd 74 78 181 55  
if $$ = 74 MINUS  
...  
if $$ < 0 END

Wait for Num-, Num+, Num/, or Num*, or animation expired, and then do something based on the result.

Core Function Library (supports the Core extension)

Core

toh_elapsed_time

Description Returns the actual game time passed at the time of the last "Top of the Hour" For example, if you slept from 1:30 to 4:00, you would get a Top of the Hour event at 4 with a value of 2.5

Example

toh_elapsed_time

$$ would contain the actual elapsed game time from the previous "Top of the Hour" event

⚠️ **GitHub.com Fallback** ⚠️