the CreationKit Wiki

Difference between revisions of "List of Papyrus Functions"

List of Papyrus Functions (edit)

Revision as of 12:14, 2 December 2021

3,232 bytes added ,  12:14, 2 December 2021
→‎G: adding functions and return types
(→‎G: wip)
(→‎G: adding functions and return types)
Line 978: Line 978:
|-
|-
|'''[[GetActorValueInfoByID - ActorValueInfo|GetActorValueInfoByID]]'''<sup>SKSE</sup>
|'''[[GetActorValueInfoByID - ActorValueInfo|GetActorValueInfoByID]]'''<sup>SKSE</sup>
|[[Actor Script|'''Actor''']]
|[[Actor Script|'''ActorValueInfo''']]
|ActorValueInfo
|ActorValueInfo
|
|
|-
|-
|'''[[GetActorValueInfoByName - ActorValueInfo|GetActorValueInfoByName]]'''<sup>SKSE</sup>
|'''[[GetActorValueInfoByName - ActorValueInfo|GetActorValueInfoByName]]'''<sup>SKSE</sup>
|[[Actor Script|'''Actor''']]
|[[Actor Script|'''ActorValueInfo''']]
|ActorValueInfo
|ActorValueInfo
|
|
Line 1,024: Line 1,024:
|
|
|-
|-
|GetAllAmmo
|'''[[GetAllAmmo - GameData|GetAllAmmo]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllArmor
|'''[[GetAllArmor - GameData|GetAllArmor]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllBooks
|'''[[GetAllBooks - GameData|GetAllBooks]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllForms
|'''[[GetAllForms - GameData|GetAllForms]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllIngredients
|'''[[GetAllIngredients - GameData|GetAllIngredients]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllKeys
|[[GetAllKeys - GameData|'''GetAllKeys''']]<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllMiscItems
|'''[[GetAllMiscItems - GameData|GetAllMiscItems]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllowDualWielding
|'''[[GetAllowDualWielding - CombatStyle|GetAllowDualWielding]]'''<sup>SKSE</sup>
|
|'''[[CombatStyle Script|CombatStyle]]'''
|
|Bool
|
|
|-
|-
|GetAllPotions
|'''[[GetAllPotions - GameData|GetAllPotions]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllScrolls
|'''[[GetAllScrolls - GameData|GetAllScrolls]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAllWeapons
|'''[[GetAllWeapons - GameData|GetAllWeapons]]'''<sup>SKSE</sup>
|'''[[GameData Script|GameData]]'''
|'''[[GameData Script|GameData]]'''
|
|Form[]
|
|
|-
|-
|GetAlpha
|'''[[GetAlpha - ColorComponent|GetAlpha]]'''<sup>SKSE</sup>
|[[ColorComponent Script|'''ColorComponent''']]
|[[ColorComponent Script|'''ColorComponent''']]
|
|Int
|
|
|-  
|-  
Line 1,087: Line 1,087:
| '''[[GetAngleX - ObjectReference|GetAngleX]]'''
| '''[[GetAngleX - ObjectReference|GetAngleX]]'''
| [[ObjectReference Script|'''ObjectReference''']]
| [[ObjectReference Script|'''ObjectReference''']]
|
|Float
|
|
|-  
|-  
Line 1,093: Line 1,093:
| '''[[GetAngleY - ObjectReference|GetAngleY]]'''
| '''[[GetAngleY - ObjectReference|GetAngleY]]'''
| [[ObjectReference Script|'''ObjectReference''']]
| [[ObjectReference Script|'''ObjectReference''']]
|
|Float
|
|
|-  
|-  
Line 1,099: Line 1,099:
| '''[[GetAngleZ - ObjectReference|GetAngleZ]]'''
| '''[[GetAngleZ - ObjectReference|GetAngleZ]]'''
| [[ObjectReference Script|'''ObjectReference''']]
| [[ObjectReference Script|'''ObjectReference''']]
|
|Float
|
|
|-  
|-  
Line 1,105: Line 1,105:
| '''[[GetAnimationVariableBool - ObjectReference|GetAnimationVariableBool]]'''
| '''[[GetAnimationVariableBool - ObjectReference|GetAnimationVariableBool]]'''
| [[ObjectReference Script|'''ObjectReference''']]
| [[ObjectReference Script|'''ObjectReference''']]
|
|Bool
|
|
|-  
|-  
Line 1,111: Line 1,111:
| '''[[GetAnimationVariableFloat - ObjectReference|GetAnimationVariableFloat]]'''
| '''[[GetAnimationVariableFloat - ObjectReference|GetAnimationVariableFloat]]'''
| [[ObjectReference Script|'''ObjectReference''']]
| [[ObjectReference Script|'''ObjectReference''']]
|
|Float
|
|
|-  
|-  
Line 1,117: Line 1,117:
| '''[[GetAnimationVariableInt - ObjectReference|GetAnimationVariableInt]]'''
| '''[[GetAnimationVariableInt - ObjectReference|GetAnimationVariableInt]]'''
| '''[[ObjectReference Script|ObjectReference]]'''
| '''[[ObjectReference Script|ObjectReference]]'''
|
|Int
|
|
|-  
|-  
Line 1,123: Line 1,123:
| '''[[GetArmorRating - Armor|GetArmorRating]]'''<sup>SKSE</sup>
| '''[[GetArmorRating - Armor|GetArmorRating]]'''<sup>SKSE</sup>
| [[Armor Script|'''Armor''']]
| [[Armor Script|'''Armor''']]
|
|Int
|
|
|-  
|-  
Line 1,129: Line 1,129:
| '''[[GetAssociatedSkill - MagicEffect|GetAssociatedSkill]]'''
| '''[[GetAssociatedSkill - MagicEffect|GetAssociatedSkill]]'''
| '''[[MagicEffect Script|MagicEffect]]'''
| '''[[MagicEffect Script|MagicEffect]]'''
|
|String
|
|
|-  
|-  
Line 1,135: Line 1,135:
| '''[[GetAt - FormList|GetAt]]'''
| '''[[GetAt - FormList|GetAt]]'''
| [[FormList Script|'''FormList''']]
| [[FormList Script|'''FormList''']]
|
|Form
|
|
|-
|-
|'''[[GetActorValue - Actor|GetAV]]'''
|'''[[GetActorValue - Actor|GetAV]]'''
|[[Actor Script|'''Actor''']]
|[[Actor Script|'''Actor''']]
|
|Float
|alias for GetActorValue
|alias for GetActorValue
|-
|-
|'''[[GetAverageFrameRate - Utility|GetAverageFrameRate]]'''
|'''[[GetAverageFrameRate - Utility|GetAverageFrameRate]]'''
|'''[[Utility Script|Utility]]'''
|'''[[Utility Script|Utility]]'''
|
|Float
|
|
|-
|-
|'''[[GetActorValueInfoByID - ActorValueInfo|GetAVIByID]]'''<sup>SKSE</sup>
|'''[[GetActorValueInfoByID - ActorValueInfo|GetAVIByID]]'''<sup>SKSE</sup>
|
|'''[[ActorValueInfo Script|ActorValueInfo]]'''
|
|ActorValueInfo
|alias for GetActorValueInfoByID
|alias for GetActorValueInfoByID
|-
|-
|'''[[GetActorValueInfoByName - ActorValueInfo|GetAVIByName]]'''<sup>SKSE</sup>
|'''[[GetActorValueInfoByName - ActorValueInfo|GetAVIByName]]'''<sup>SKSE</sup>
|
|'''[[ActorValueInfo Script|ActorValueInfo]]'''
|
|ActorValueInfo
|alias for GetActorValueInfoByName
|alias for GetActorValueInfoByName
|-
|-
|'''[[GetActorValueMax - Actor|GetAVMax]]'''
|'''[[GetActorValueMax - Actor|GetAVMax]]'''
|[[Actor Script|'''Actor''']]
|[[Actor Script|'''Actor''']]
|Float
|alias for GetActorValueMax
|-
|'''[[GetAvoidThreatChance - CombatStyle|GetAvoidThreatChance]]'''
|'''[[CombatStyle Script|CombatStyle]]'''
|Float
|
|
|alias for GetActorValueMax
|-
|-
|'''[[GetActorValuePercentage - Actor|GetAVPercentage]]'''
|'''[[GetActorValuePercentage - Actor|GetAVPercentage]]'''
|[[Actor Script|'''Actor''']]
|[[Actor Script|'''Actor''']]
|
|Float
|alias for GetActorValuePercentage
|alias for GetActorValuePercentage
|-  
|-  
Line 1,171: Line 1,176:
| '''[[GetBaseActorValue - Actor|GetBaseActorValue]]'''
| '''[[GetBaseActorValue - Actor|GetBaseActorValue]]'''
| [[Actor Script|'''Actor''']]
| [[Actor Script|'''Actor''']]
|
|Float
|
|
|-
|-
|'''[[GetBaseActorValue - Actor|GetBaseAV]]'''
|'''[[GetBaseActorValue - Actor|GetBaseAV]]'''
|[[Actor Script|'''Actor''']]
|[[Actor Script|'''Actor''']]
|Float
|alias for GetBaseActorValue
|-
|'''[[GetBaseCost - MagicEffect|GetBaseCost]]'''<sup>SKSE</sup>
|'''[[MagicEffect Script|MagicEffect]]'''
|Float
|
|
|alias for GetBaseActorValue
|-  
|-  
   
   
| '''[[GetBaseDamage - Weapon|GetBaseDamage]]'''<sup>SKSE</sup>
| '''[[GetBaseDamage - Weapon|GetBaseDamage]]'''<sup>SKSE</sup>
| [[Weapon Script|'''Weapon''']]
| [[Weapon Script|'''Weapon''']]
|
|Int
|
|
|-  
|-  
Line 1,188: Line 1,198:
| '''[[GetBaseObject - ActiveMagicEffect|GetBaseObject]]'''
| '''[[GetBaseObject - ActiveMagicEffect|GetBaseObject]]'''
| [[ActiveMagicEffect Script|'''ActiveMagicEffect''']]
| [[ActiveMagicEffect Script|'''ActiveMagicEffect''']]
|
|MagicEffect
|
|
|-  
|-  
Line 1,194: Line 1,204:
| '''[[GetBaseObject - ObjectReference|GetBaseObject]]'''
| '''[[GetBaseObject - ObjectReference|GetBaseObject]]'''
| [[ObjectReference Script|'''ObjectReference''']]
| [[ObjectReference Script|'''ObjectReference''']]
|Form
|
|
|-
|'''[[GetBaseValue - ActiveMagicEffect|GetBaseValue]]'''
|[[ActiveMagicEffect Script|'''ActiveMagicEffect''']]
|Float
|
|
|-
|'''[[GetBlue - ColorComponent|GetBlue]]'''<sup>SKSE</sup>
|'''[[ColorComponent Script|ColorComponent]]'''
|Int
|global function
|-  
|-  
   
   
| '''[[GetBlue - ColorForm|GetBlue]]'''<sup>SKSE</sup>
| '''[[GetBlue - ColorForm|GetBlue]]'''<sup>SKSE</sup>
| [[ColorForm Script|'''ColorForm''']]
| [[ColorForm Script|'''ColorForm''']]
|
|Int
|
|
|-
|-
|'''[[GetBool - UI|GetBool]]'''<sup>SKSE</sup>
|'''[[GetBool - UI|GetBool]]'''<sup>SKSE</sup>
|[[UI Script|'''UI''']]
|[[UI Script|'''UI''']]
|
|Bool
|
|
|-  
|-  
Line 1,211: Line 1,231:
| '''[[GetBribeAmount - Actor|GetBribeAmount]]'''
| '''[[GetBribeAmount - Actor|GetBribeAmount]]'''
| [[Actor Script|'''Actor''']]
| [[Actor Script|'''Actor''']]
|
|Int
|
|
|-
|-
|'''[[GetBudgetCount - Utility|GetBudgetCount]]'''
|'''[[GetBudgetCount - Utility|GetBudgetCount]]'''
|'''[[Utility Script|Utility]]'''
|'''[[Utility Script|Utility]]'''
|
|Int
|
|
|-
|-
|'''[[GetBudgetName - Utility|GetBudgetName]]'''
|'''[[GetBudgetName - Utility|GetBudgetName]]'''
|'''[[Utility Script|Utility]]'''
|'''[[Utility Script|Utility]]'''
|String
|
|-
|'''[[GetBuySellList - Faction|GetBuySellList]]'''<sup>SKSE</sup>
|'''[[Faction Script|Faction]]'''
|FormList
|
|-
|'''[[GetCameraState - Camera|GetCameraState]]'''<sup>SKSE</sup>
|'''[[Camera Script|Camera]]'''
|Int
|
|
|-
|'''[[GetCameraState - Game|GetCameraState]]'''<sup>SKSE</sup>
|'''[[Game Script|Game]]'''
|Int
|
|
|-  
|-  
Line 1,227: Line 1,262:
| '''[[GetCasterActor - ActiveMagicEffect|GetCasterActor]]'''
| '''[[GetCasterActor - ActiveMagicEffect|GetCasterActor]]'''
| [[ActiveMagicEffect Script|'''ActiveMagicEffect''']]
| [[ActiveMagicEffect Script|'''ActiveMagicEffect''']]
|Actor
|
|
|-
|'''[[GetCastTime - MagicEffect|GetCastTime]]'''<sup>SKSE</sup>
|'''[[MagicEffect Script|MagicEffect]]'''
|Float
|
|
|-  
|-  
Line 1,233: Line 1,273:
| '''[[GetCastTime - Scroll|GetCastTime]]'''<sup>SKSE</sup>
| '''[[GetCastTime - Scroll|GetCastTime]]'''<sup>SKSE</sup>
| [[Scroll Script|'''Scroll''']]
| [[Scroll Script|'''Scroll''']]
|
|Float
|
|
|-  
|-  
Line 1,239: Line 1,279:
| '''[[GetCastTime - Spell|GetCastTime]]'''<sup>SKSE</sup>
| '''[[GetCastTime - Spell|GetCastTime]]'''<sup>SKSE</sup>
| [[Spell Script|'''Spell''']]
| [[Spell Script|'''Spell''']]
|Float
|
|
|-
|'''[[GetChanceGlobal - LeveledItem|GetChanceGlobal]]'''<sup>SKSE</sup>
|'''[[LeveledItem Script|LeveledItem]]'''
|GlobalVariable
|
|-
|'''[[GetChanceNone - LeveledItem|GetChanceNone]]'''<sup>SKSE</sup>
|'''[[LeveledItem Script|LeveledItem]]'''
|Int
|
|-
|'''[[GetChanceNone - LeveledSpell|GetChanceNone]]'''<sup>SKSE</sup>
|'''[[LeveledSpell Script|LeveledSpell]]'''
|Int
|
|
|-  
|-  
Line 1,245: Line 1,300:
| '''[[GetClass - ActorBase|GetClass]]'''
| '''[[GetClass - ActorBase|GetClass]]'''
| [[ActorBase Script|'''ActorBase''']]
| [[ActorBase Script|'''ActorBase''']]
|
|Class
|
|
|-  
|-  
Line 1,251: Line 1,306:
| '''[[GetClassification - Weather|GetClassification]]'''
| '''[[GetClassification - Weather|GetClassification]]'''
| [[Weather Script|'''Weather''']]
| [[Weather Script|'''Weather''']]
|Int
|
|
|-
|'''[[GetCloseRangeDuelingCircleMult - CombatStyle|GetCloseRangeDuelingCircleMult]]'''<sup>SKSE</sup>
|'''[[CombatStyle Script|CombatStyle]]'''
|Float
|
|-
|'''[[GetCloseRangeDuelingFallbackMult - CombatStyle|GetCloseRangeDuelingFallbackMult]]'''<sup>SKSE</sup>
|'''[[CombatStyle Script|CombatStyle]]'''
|Float
|
|-
|'''[[GetCloseRangeFlankingFlankDistance - CombatStyle|GetCloseRangeFlankingFlankDistance]]'''<sup>SKSE</sup>
|'''[[CombatStyle Script|CombatStyle]]'''
|Float
|
|-
|'''[[GetCloseRangeFlankingStalkTime - CombatStyle|GetCloseRangeFlankingStalkTime]]'''<sup>SKSE</sup>
|'''[[CombatStyle Script|CombatStyle]]'''
|Float
|
|-
|'''[[GetColor - ColorForm|GetColor]]'''<sup>SKSE</sup>
|'''[[ColorForm Script|ColorForm]]'''
|Int
|
|
|-  
|-  
Line 1,257: Line 1,337:
| '''[[GetCombatState - Actor|GetCombatState]]'''
| '''[[GetCombatState - Actor|GetCombatState]]'''
| [[Actor Script|'''Actor''']]
| [[Actor Script|'''Actor''']]
|
|Int
|
|
|-  
|-  
Line 1,263: Line 1,343:
| '''[[GetCombatStyle - ActorBase|GetCombatStyle]]'''<sup>SKSE</sup>
| '''[[GetCombatStyle - ActorBase|GetCombatStyle]]'''<sup>SKSE</sup>
| [[ActorBase Script|'''ActorBase''']]
| [[ActorBase Script|'''ActorBase''']]
|
|CombatStyle
|
|
|-  
|-  
Line 1,269: Line 1,349:
| '''[[GetCombatTarget - Actor|GetCombatTarget]]'''
| '''[[GetCombatTarget - Actor|GetCombatTarget]]'''
| [[Actor Script|'''Actor''']]
| [[Actor Script|'''Actor''']]
|
|Actor
|
|
|-  
|-  
Line 1,275: Line 1,355:
| '''[[GetConfigName - Debug|GetConfigName]]'''
| '''[[GetConfigName - Debug|GetConfigName]]'''
| [[Debug Script|'''Debug''']]
| [[Debug Script|'''Debug''']]
|String
|
|
|-
|'''[[GetContainerForms - ObjectReference|GetContainerForms]]'''<sup>SKSE</sup>
|[[ObjectReference Script|'''ObjectReference''']]
|Form[]
|
|
|-  
|-  
Line 1,281: Line 1,366:
| '''[[GetCostliestEffectIndex - Enchantment|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[GetCostliestEffectIndex - Enchantment|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[Enchantment Script|Enchantment]]'''
| '''[[Enchantment Script|Enchantment]]'''
|
|Int
|
|
|-  
|-  
Line 1,287: Line 1,372:
| '''[[GetCostliestEffectIndex - Ingredient|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[GetCostliestEffectIndex - Ingredient|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[Ingredient Script|Ingredient]]'''
| '''[[Ingredient Script|Ingredient]]'''
|
|Int
|
|
|-  
|-  
Line 1,293: Line 1,378:
| '''[[GetCostliestEffectIndex - Potion|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[GetCostliestEffectIndex - Potion|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[Potion Script|Potion]]'''
| '''[[Potion Script|Potion]]'''
|
|Int
|
|
|-  
|-  
Line 1,299: Line 1,384:
| '''[[GetCostliestEffectIndex - Scroll|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[GetCostliestEffectIndex - Scroll|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| [[Scroll Script|'''Scroll''']]
| [[Scroll Script|'''Scroll''']]
|
|Int
|
|
|-  
|-  
Line 1,305: Line 1,390:
| '''[[GetCostliestEffectIndex - Spell|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| '''[[GetCostliestEffectIndex - Spell|GetCostliestEffectIndex]]'''<sup>SKSE</sup>
| [[Spell Script|'''Spell''']]
| [[Spell Script|'''Spell''']]
|
|Int
|
|
|-  
|-  
Line 1,311: Line 1,396:
| '''[[GetCrimeFaction - Actor|GetCrimeFaction]]'''
| '''[[GetCrimeFaction - Actor|GetCrimeFaction]]'''
| [[Actor Script|'''Actor''']]
| [[Actor Script|'''Actor''']]
|
|Faction
|
|
|-  
|-  
Line 1,317: Line 1,402:
| '''[[GetCrimeGold - Faction|GetCrimeGold]]'''
| '''[[GetCrimeGold - Faction|GetCrimeGold]]'''
| [[Faction Script|'''Faction''']]
| [[Faction Script|'''Faction''']]
|
|Int
|
|
|-  
|-  
Line 1,323: Line 1,408:
| '''[[GetCrimeGoldNonViolent - Faction|GetCrimeGoldNonViolent]]'''
| '''[[GetCrimeGoldNonViolent - Faction|GetCrimeGoldNonViolent]]'''
| [[Faction Script|'''Faction''']]
| [[Faction Script|'''Faction''']]
|
|Int
|
|
|-  
|-  
Line 1,329: Line 1,414:
| '''[[GetCrimeGoldViolent - Faction|GetCrimeGoldViolent]]'''
| '''[[GetCrimeGoldViolent - Faction|GetCrimeGoldViolent]]'''
| [[Faction Script|'''Faction''']]
| [[Faction Script|'''Faction''']]
|
|Int
|
|
|-  
|-  
Cecell
149

edits

Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/22872"