Editing
Form Script
(section)
Jump to navigation
Jump to search
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!
== SKSE Member Functions == :'''Int [[GetType - Form|GetType]]()''' :*Returns this form's form typecode. :'''String [[GetName - Form|GetName]]()''' :*Returns this form's full name. :'''[[SetName - Form|SetName]](String ''name'')''' :*Sets this form's full name. :'''Float [[GetWeight - Form|GetWeight]]()''' :*Returns this form's weight. :'''[[SetWeight - Form|SetWeight]](Float ''weight'')''' :*Sets this form's weight. :'''[[SetGoldValue - Form|SetGoldValue]](Int ''value'')''' :*Sets this form's base gold value. :'''Int [[GetNumKeywords - Form|GetNumKeywords]]()''' :*Returns the number of keywords on this form. :'''Keyword [[GetNthKeyword - Form|GetNthKeyword]](Int ''index'')''' :*Returns the keyword specified by index on this form. :'''Bool [[HasKeywordString - Form|HasKeywordString]](String ''s'')''' :*Returns whether this form has a keyword with the specified string. :'''[[SetPlayerKnows - Form|SetPlayerKnows]](Bool ''knows'')''' :*Sets whether the player know this form. Should only be used For Magic Effects, Words of Power and Enchantments. :'''Bool [[IsPlayable - Form|IsPlayable]]()''' :*Returns if the form is marked playable or not. Only works on forms that have that flag, such as Armors. :'''Bool [[HasWorldModel - Form|HasWorldModel]]()''' :*Returns whether this form has a world model or not. :'''String [[GetWorldModelPath - Form|GetWorldModelPath]]()''' :*Gets this form's world model. :'''[[SetWorldModelPath - Form|SetWorldModelPath]](String ''path'')''' :*Sets this form's world model. :'''Int [[GetWorldModelNumTextureSets - Form|GetWorldModelNumTextureSets]]()''' :*Returns the number of texture sets the world model has. :'''TextureSet [[GetWorldModelNthTextureSet - Form|GetWorldModelNthTextureSet]](Int ''n'')''' :*Returns the Nth texture set of the forms world model. :'''[[SetWorldModelNthTextureSet - Form|SetWorldModelNthTextureSet]](TextureSet ''nSet'', Int ''n'')''' :*Sets the Nth texture set of the forms world model to the specified TextureSet. :'''[[RegisterForKey - Form|RegisterForKey]](Int ''keyCode'')''' :*Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events. :'''[[UnregisterForKey - Form|UnregisterForKey]](Int ''keyCode'')''' :*Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events. :'''[[UnregisterForAllKeys - Form|UnregisterForAllKeys]]()''' :*Unregisters all registered [[Input_Script#DXScanCodes|DXScanCodes]]. :'''[[RegisterForControl - Form|RegisterForControl]](String ''control'')''' :*Registers the given control for OnControlDown and OnControlUp events. :'''[[UnregisterForControl - Form|UnregisterForControl]](String ''control'')''' :*Unregisters the given control for OnControlDown and OnControlUp events. :'''[[UnregisterForAllControls - Form|UnregisterForAllControls]]()''' :*Unregisters all registered controls. :'''[[RegisterForMenu - Form|RegisterForMenu]](String ''menuName'')''' :*Registers for OnMenuOpen and OnMenuClose events for the given menu. :'''[[UnregisterForMenu - Form|UnregisterForMenu]](String ''menuName'')''' :*Unregisters for OnMenuOpen and OnMenuClose events for the given menu. :'''[[UnregisterForAllMenus - Form|UnregisterForAllMenus]]()''' :*Unregisters all registered menus. :'''[[RegisterForModEvent - Form|RegisterForModEvent]](String ''eventName'', String ''callbackName'')''' :*Registers a custom event callback for given event name. :'''[[SendModEvent|SendModEvent]](String ''eventName'', String ''strArg'', Float ''numArg'')''' :*Sends a custom event with given generic parameters. :'''[[UnregisterForModEvent - Form|UnregisterForModEvent]](String ''eventName'')''' :*Unregisters a custom event callback for given event name. :'''[[UnregisterForAllModEvents|UnregisterForAllModEvents]]()''' :*Unregisters all registered custom events. :'''Form [[TempClone - Form|TempClone]]()''' :*Returns a temporary clone of this form :'''[[RegisterForCameraState - Form|RegisterForCameraState]]()''' :*Registers for OnPlayerCameraState events. :'''[[UnregisterForCameraState - Form|UnregisterForCameraState]]()''' :*Unregisters for OnPlayerCameraState events. :'''[[RegisterForCrosshairRef - Form|RegisterForCrosshairRef]]()''' :*Registers for OnCrosshairRefChange events. :'''[[UnregisterForCrosshairRef - Form|UnregisterForCrosshairRef]]()''' :*Unregisters for OnCrosshairRefChange events. :'''[[RegisterForActorAction - Form|RegisterForActorAction]](Int ''actionType'')''' :*Registers for OnActorAction events. :'''[[UnregisterForActorAction - Form|UnregisterForActorAction]](Int ''actionType'')''' :*Unregisters for OnActorAction events. :'''[[RegisterForNiNodeUpdate]]()''' :*Registers the script for when a QueueNiNodeUpdate is called :'''[[UnregisterForNiNodeUpdate]]()''' :*Unregisters the script for when a QueueNiNodeUpdate is called
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)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Search
Navigation
Landing page
Tutorials
Game Systems
Editor Reference
Scripting Reference
Recent changes
Help
Tools
What links here
Related changes
Special pages
Page information
Page values