Open main menu
Home
Random
Log in
Settings
About the CreationKit Wiki
Disclaimers
the CreationKit Wiki
Search
Editing
Form Script
(section)
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Member Functions == :'''Int [[GetFormID - Form|GetFormID]]()''' :*Returns this form's form ID. :'''Int [[GetGoldValue - Form|GetGoldValue]]()''' :*Returns this form's value in gold. :'''Bool [[HasKeyword - Form|HasKeyword]](Keyword ''akKeyword'')''' :*Returns if this form has the specified [[Keyword Script|Keyword]] attached. :'''Bool [[PlayerKnows - Form|PlayerKnows]]()''' :*Is the "Known" flag set on the form? :'''[[RegisterForAnimationEvent - Form|RegisterForAnimationEvent]](ObjectReference ''akSender'', String ''asEventName'')''' :*Registers this form to receive the specified animation event from the specified object. :'''[[RegisterForLOS - Form|RegisterForLOS]](Actor ''akViewer'', ObjectReference ''akTarget'')''' :*Registers this form to receive gain and lost LOS events between the viewer and the target. :'''[[RegisterForSingleLOSGain - Form|RegisterForSingleLOSGain]](Actor ''akViewer'', ObjectReference ''akTarget'')''' :*Registers this form to receive a single LOS gain event when the viewer sees the target. :'''[[RegisterForSingleLOSLost - Form|RegisterForSingleLOSLost]](Actor ''akViewer'', ObjectReference ''akTarget'')''' :*Registers this form to receive a single LOS lost event when the viewer loses sight of the target. :'''[[RegisterForSingleUpdate - Form|RegisterForSingleUpdate]](Float ''afInterval'')''' :*Registers this form to receive a single update event in the specified time. :'''[[RegisterForSingleUpdateGameTime - Form|RegisterForSingleUpdateGameTime]](Float ''afInterval'')''' :*Registers this form to receive a single update event in the specified number of game hours. :'''[[RegisterForSleep - Form|RegisterForSleep]]()''' :*Registers this form to receive sleep events for when the player goes to sleep or wakes up. :'''[[RegisterForTrackedStatsEvent - Form|RegisterForTrackedStatsEvent]]()''' :*Registers this form to receive tracked stats events for when tracked stats are updated. :'''[[RegisterForUpdate - Form|RegisterForUpdate]](Float ''afInterval'')''' :*Registers this form to receive update events with the specified interval, or changes the update interval. :'''[[RegisterForUpdateGameTime - Form|RegisterForUpdateGameTime]](Float ''afInterval'')''' :*Registers this form to receive update events with the specified interval in game time hours, or changes the update interval. :'''[[StartObjectProfiling - Form|StartObjectProfiling]]()''' :*Starts profiling all scripts attached to this form. :'''[[StopObjectProfiling - Form|StopObjectProfiling]]()''' :*Stops profiling all scripts attached to this form. :'''[[UnregisterForAnimationEvent - Form|UnregisterForAnimationEvent]](ObjectReference ''akSender'', String ''asEventName'')''' :*Unregisters this from from receiving the specified animation event from the specified object. :'''[[UnregisterForLOS - Form|UnregisterForLOS]](Actor ''akViewer'', ObjectReference ''akTarget'')''' :*Unregisters this form from any LOS events between the viewer and target. :'''[[UnregisterForSleep - Form|UnregisterForSleep]]()''' :*Unregisters this form from sleep events. :'''[[UnregisterForTrackedStatsEvent - Form|UnregisterForTrackedStatsEvent]]()''' :*Unregisters this form from tracked stats events. :'''[[UnregisterForUpdate - Form|UnregisterForUpdate]]()''' :*Unregisters this form from update events. :'''[[UnregisterForUpdateGameTime - Form|UnregisterForUpdateGameTime]]()''' :*Unregisters this form from game time update events.
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)