Difference between revisions of "Perk Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(Crosslinked to editor reference)
imported>Qazaaq
m (category)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
 
<BR/>
'''Editor:''' [[Perk]]
'''Editor:''' [[Perk]]


Line 21: Line 18:
== Member Functions ==
== Member Functions ==
None
None
== F4SE Member Functions ==
*int Function [[GetLevel - Perk|GetLevel]]()
**Returns the level requirement on this perk.
*Perk Function [[GetNextPerk - Perk|GetNextPerk]]()
**Returns the next perk on this perk's chain.
*int Function [[GetNumRanks - Perk|GetNumRanks]]()
**Returns the number of ranks this perk has.
*string Function [[GetSWFPath - Perk|GetSWFPath]]()
**Returns this perk's SWF path as a string.
*bool Function [[IsEligible - Perk|IsEligible]](Actor akActor)
**Returns true if the actor meets this perk's conditions..
*bool Function [[IsHidden - Perk|IsHidden]]()
**Returns true if this perk is hidden.
*bool Function [[IsPlayable - Perk|IsPlayable]]()
**Returns true if this perk is playable.


== Events ==
== Events ==
Line 26: Line 45:
**Event called whenever an entry point on this perk is fired.
**Event called whenever an entry point on this perk is fired.


== Related Fragments ==
== See Also ==
*[[Perk Fragments]]
*[[Perk Fragments]]
*[[:Category:Actor|Actor Category]]
[[Category:Papyrus]]
[[Category:Scripting]]
[[Category:Script Objects]]
[[Category:Actor]]

Latest revision as of 23:27, 29 October 2017

Extends: Form Script
Editor: Perk

Script for the manipulation of perk instances.

Definition[edit | edit source]

ScriptName Perk extends Form Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

None

F4SE Member Functions[edit | edit source]

  • int Function GetLevel()
    • Returns the level requirement on this perk.
  • Perk Function GetNextPerk()
    • Returns the next perk on this perk's chain.
  • int Function GetNumRanks()
    • Returns the number of ranks this perk has.
  • string Function GetSWFPath()
    • Returns this perk's SWF path as a string.
  • bool Function IsEligible(Actor akActor)
    • Returns true if the actor meets this perk's conditions..
  • bool Function IsHidden()
    • Returns true if this perk is hidden.
  • bool Function IsPlayable()
    • Returns true if this perk is playable.

Events[edit | edit source]

  • Event OnEntryRun(int auiEntryID, ObjectReference akTarget, Actor akOwner)
    • Event called whenever an entry point on this perk is fired.

See Also[edit | edit source]