Difference between revisions of "List of Papyrus Functions"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(Created page, Added Functions A-B)
 
imported>CraftySentinel
(Updated to use Function Table Template for easier editing also added functions starting with C)
Line 7: Line 7:
{{Compact ToC|x=|z=}}
{{Compact ToC|x=|z=}}
=== A ===
=== A ===
{|class="toccolours sortable" style="width:100%; font-size:85%; font-weight:bold;"
{{Function Table
!align=left width=90|Member of
|func01=Abs
!align=left width=170|Function
|memb01=Math
!align=left class="unsortable"|Description
|desc01=
|-
|Math||[[Abs - Math|Abs]]|| The Absolute Value
|-
|Math||[[Acos - Math|Acos]]||
|-
|ObjectReference||[[Activate - ObjectReference|Activate]]|| Activate the object with the specified object.
|-
|MusicType||[[Add - MusicType|Add]]||
|-
|Topic||[[Add - Topic|Add]]||
|-
|Game||[[AddAchievement - Game|AddAchievement]]||
|-
|FormList||[[AddForm - FormList|AddForm]]|| Adds the specified Form to the FormList.
|-
|LevelActor||[[AddForm - LeveledActor|AddForm]]||Adds the specified Form to the LeveledActor list at the specified level.
|-
|LeveledItem||[[AddForm - LeveledItem|AddForm]]||Adds the specified Form to the LeveledItem list at the specified level.
|-
|LevelSpell||[[AddForm - LeveledSpell|AddForm]]||Adds the specified Form to the LeveledSpell list at the specified level.
|-
|Game||[[AddHavokBallAndSocketConstraint - Game|AddHavokBallAndSocketConstraint]]||Adds a havok ball and socket joint between two rigid bodies.
|-
|ObjectReference||[[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]]
|-
|ObjectReference||[[AddItem - ObjectReference|AddItem ]]
|-
|ObjectReference||[[AddKeyIfNeeded - ObjectReference|AddKeyIfNeeded]]
|-
|Actor||[[AddPerk - Actor|AddPerk]]
|-
|Game||[[AddPerkPoints - Game|AddPerkPoints]]
|-
|Actor||[[AddShout - Actor|AddShout]]
|-
|Armor<sup><span style="font-weight:normal;">SKSE</span></sup>||[[AddSlotToMask - Armor|AddSlotToMask]]
|-
|Actor||[[AddSpell - Actor|AddSpell]]
|-
|Actor||[[AddToFaction - Actor|AddToFaction]]
|-
|ObjectReference||[[AddToMap - ObjectReference|AddToMap]]
|-
|Game||[[AdvanceSkill - Game|AdvanceSkill]]
|-
|Actor||[[AllowBleedoutDialogue - Actor|AllowBleedoutDialogue]]
|-
|Actor||[[AllowPCDialogue - Actor|AllowPCDialogue]]
|-
|ImageSpaceModifier||[[Apply - ImageSpaceModifier|Apply]]
|-
|ImageSpaceModifier||[[ApplyCrossFade - ImageSpaceModifier|ApplyCrossFade]]
|-
|ObjectReference||[[ApplyHavokImpulse - ObjectReference|ApplyHavokImpulse]]
|-
|Math||[[Asin - Math|Asin]]
|-
|Math||[[Atan - Math|Atan]]
|-
|Actor||[[AttachAshPile - Actor|AttachAshPile]]
|}


|func02=Acos
|memb02=Math
|desc02=
|func03=Activate
|memb03=ObjectReference
|desc03=
|func04=Add
|memb04=MusicType
|desc04=
|func05=Add
|memb05=Topic
|desc05=
|func06=AddAchievement
|memb06=Game
|desc06=
|func07=AddForm
|memb07=FormList
|desc07=
|func08=AddForm
|memb08=LeveledActor
|desc08=
|func09=AddForm
|memb09=LeveledItem
|desc09=
|func10=AddForm
|memb10=LeveledSpell
|desc10=
|func11=AddHavokBallAndSocketConstraint
|memb11=Game
|desc11=
|func12=AddInventoryEventFilter
|memb12=ObjectReference
|desc12=
|func13=AddItem
|memb13=ObjectReference
|desc13=
|func14=AddKeyIfNeeded
|memb14=ObjectReference
|desc14=
|func15=AddPerk
|memb15=Actor
|desc15=
|func16=AddPerkPoints
|memb16=Game
|desc16=
|func17=AddShout
|memb17=Actor
|desc17=
|func18=AddSlotToMask
|memb18=Armor
|skse18=yes
|desc18=
|func19=AddSpell
|memb19=Actor
|desc19=
|func20=AddToFaction
|memb20=Actor
|desc20=
|func21=AddToMap
|memb21=ObjectReference
|desc21=
|func22=AdvanceSkill
|memb22=Game
|desc22=
|func23=AllowBleedoutDialogue
|memb23=Actor
|desc23=
|func24=AllowPCDialogue
|memb24=Actor
|desc24=
|func25=Apply
|memb25=ImageSpaceModifier
|desc25=
|func26=ApplyCrossFade
|memb26=ImageSpaceModifier
|desc26=
|func27=ApplyHavokImpulse
|memb27=ObjectReference
|desc27=
|func28=Asin
|memb28=Math
|desc28=
|func29=Atan
|memb29=Math
|desc29=
|func30=AttachAshPile
|memb30=Actor
|desc30=
}}
=== B ===
=== B ===
{|class="toccolours sortable" style="width:100%; font-size:85%; font-weight:bold;"
{{Function Table
!align=left width=90|Member of
 
!align=left width=170|Function
|func01=BlockActivation
!align=left class="unsortable"|Description
|memb01=ObjectReference
|-
|desc01=
|ObjectReference||[[BlockActivation - ObjectReference|BlockActivation]]||
 
|-
}}
|}
=== C ===
=== C ===
{{Function Table
|func01=CalculateEncounterLevel
|memb01=ObjectReference
|desc01=
|func02=CalculateFavorCost
|memb02=Game
|desc02=
|func03=CanFastTravelToMarker
|memb03=ObjectReference
|desc03=
|func04=CanFlyHere
|memb04=Actor
|desc04=
|func05=CanPayCrimeGold
|memb05=Faction
|desc05=
|func06=Cast
|memb06=Scroll
|desc06=
|func07=Cast
|memb07=Spell
|desc07=
|func08=Ceiling
|memb08=Math
|desc08=
|func09=CenterOnCell
|memb09=Debug
|desc09=
|func10=CenterOnCellAndWait
|memb10=Debug
|desc10=
|func11=ChangeHeadPart
|memb11=Actor
|skse11=yes
|desc11=
|func12=Clear
|memb12=LocationAlias
|desc12=
|func13=Clear
|memb13=ReferenceAlias
|desc13=
|func14=ClearArrested
|memb14=Actor
|desc14=
|func15=ClearDestruction
|memb15=ObjectReference
|desc15=
|func16=ClearExpressionOverride
|memb16=Actor
|desc16=
|func17=ClearExtraArrows
|memb17=Actor
|desc17=
|func18=ClearForcedLandingMarker
|memb18=Actor
|desc18=
|func19=ClearKeepOffsetFromActor
|memb19=Actor
|desc19=
|func20=ClearLookAt
|memb20=Actor
|desc20=
|func21=ClearPrison
|memb21=Game
|desc21=
|func22=ClearRaceFlag
|memb22=Race
|skse22=yes
|desc22=
|func23=ClearTempEffects
|memb23=Game
|desc23=
|func24=CloseUserLog
|memb24=Debug
|desc24=
|func25=CompleteAllObjectives
|memb25=Quest
|desc25=
|func26=CompleteQuest
|memb26=Quest
|desc26=
|func27=Cos
|memb27=Math
|desc27=
|func28=CountLinkedRefChain
|memb28=ObjectReference
|desc28=
|func29=CreateDetectionEvent
|memb29=ObjectReference
|desc29=
}}
=== D ===
=== D ===
=== E ===
=== E ===

Revision as of 08:34, 25 August 2013

200px Alert image.png TAKE NOTICE!

This article has been flagged as incomplete or inaccurate. Take any information here with a grain of salt.

Help out! If you have the knowledge needed, please edit this article so we can remove the Incomplete flag.


This Page Contains lists of all Papyrus Scripting Functions including SKSE functions.

The left column indicates in which base script the function is defined and also has a SKSE suffix if the function was added by SKSE.

Contents
A B C D E F G H I J K L M N O P Q R S T U V W Y

A

Member of: ObjectReference Script

Activates this item with the specified reference as the activator.

Syntax

bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native

Parameters

  • akActivator: Who will activate this object.
  • abDefaultProcessingOnly: If true, no OnActivate event will be sent to any scripts and the object will ignore the blocked flag.
    • Default: False

Return Value

return info

Examples

; Have the player 'activate' the door
NeatDoor.Activate(Game.GetPlayer())


; Have the player 'activate' the door, bypassing any blocked activation and NOT sending an event to any script
NeatDoor.Activate(Game.GetPlayer(), true)

Notes

Some notes, a reference: OnActivate

See Also

B

Member of: ObjectReference Script

Activates this item with the specified reference as the activator.

Syntax

bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native

Parameters

  • akActivator: Who will activate this object.
  • abDefaultProcessingOnly: If true, no OnActivate event will be sent to any scripts and the object will ignore the blocked flag.
    • Default: False

Return Value

return info

Examples

; Have the player 'activate' the door
NeatDoor.Activate(Game.GetPlayer())


; Have the player 'activate' the door, bypassing any blocked activation and NOT sending an event to any script
NeatDoor.Activate(Game.GetPlayer(), true)

Notes

Some notes, a reference: OnActivate

See Also

C

Member of: ObjectReference Script

Activates this item with the specified reference as the activator.

Syntax

bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native

Parameters

  • akActivator: Who will activate this object.
  • abDefaultProcessingOnly: If true, no OnActivate event will be sent to any scripts and the object will ignore the blocked flag.
    • Default: False

Return Value

return info

Examples

; Have the player 'activate' the door
NeatDoor.Activate(Game.GetPlayer())


; Have the player 'activate' the door, bypassing any blocked activation and NOT sending an event to any script
NeatDoor.Activate(Game.GetPlayer(), true)

Notes

Some notes, a reference: OnActivate

See Also


D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

W

Retrieved from "https://ck.uesp.net/w/index.php?title=List_of_Papyrus_Functions&oldid=12806"