Difference between revisions of "Keyword Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>CraftySentinel
(Reverted to list)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 21: Line 15:


== SKSE Global Functions ==
== SKSE Global Functions ==
'''Keyword Function [[GetKeyword - Keyword|GetKeyword]](string key)'''
 
*Returns the keyword associated with the string.
:'''Keyword [[GetKeyword - Keyword|GetKeyword]](String ''asKeyword'')'''
:*Returns the keyword associated with the string.
 


== Member Functions ==
== Member Functions ==
'''Function [[SendStoryEvent - Keyword|SendStoryEvent]](Location akLoc, ObjectReference akRef1, ObjectReference akRef2, int aiValue1, int aiValue2)'''
*Sends this keyword as a story event to the story manager.


'''bool Function [[SendStoryEventAndWait - Keyword|SendStoryEventAndWait]](Location akLoc, ObjectReference akRef1, ObjectReference akRef2, int aiValue1, int aiValue2)'''
:'''[[SendStoryEvent - Keyword|SendStoryEvent]](Location ''akLoc'', ObjectReference ''akRef1'', ObjectReference ''akRef2'', Int ''aiValue1'', Int ''aiValue2'')'''
*Sends this keyword as a story event to the story manager and waits for it to be processed. Returns true if a quest was started.
:*Sends this keyword as a story event to the story manager.
 
:'''Bool [[SendStoryEventAndWait - Keyword|SendStoryEventAndWait]](Location ''akLoc'', ObjectReference ''akRef1'', ObjectReference ''akRef2'', Int ''aiValue1'', Int ''aiValue2'')'''
:*Sends this keyword as a story event to the story manager and waits for it to be processed. Returns true if a quest was started.
 


== SKSE Member Functions ==
== SKSE Member Functions ==
'''string Function [[GetString - Keyword|GetString]]()'''
 
*Returns the string associated with the keyword.
:'''String [[GetString - Keyword|GetString]]()'''
:*Returns the string associated with the keyword.
 


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]

Latest revision as of 19:15, 2 February 2014

Extends: Form Script

Script for the manipulation of keyword objects.

Definition[edit | edit source]

ScriptName Keyword extends Form

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

SKSE Global Functions[edit | edit source]

Keyword GetKeyword(String asKeyword)
  • Returns the keyword associated with the string.


Member Functions[edit | edit source]

SendStoryEvent(Location akLoc, ObjectReference akRef1, ObjectReference akRef2, Int aiValue1, Int aiValue2)
  • Sends this keyword as a story event to the story manager.
Bool SendStoryEventAndWait(Location akLoc, ObjectReference akRef1, ObjectReference akRef2, Int aiValue1, Int aiValue2)
  • Sends this keyword as a story event to the story manager and waits for it to be processed. Returns true if a quest was started.


SKSE Member Functions[edit | edit source]

String GetString()
  • Returns the string associated with the keyword.


Events[edit | edit source]

None