Difference between revisions of "User:Scrivener07/Menus"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
imported>Qazaaq
Line 1: Line 1:
These are my notes and findings about Actionscript 3 & Scaleform in Fallout 4.
== F4SE ==
== F4SE ==
* <code>GetMembers : function Function() {}</code>
[[:Category:F4SE|F4SE]] will install a code object to the root of any registered menu.
* <code>CallFunctionNoWait : function Function() {}</code>
To acquire the F4SE code object in AS3, use <code>(stage.getChildAt(0) as MovieClip).f4se</code>.
* <code>MountImage : function Function() {}</code>
It is a good idea to wrap calls to the F4SE code object in a Try/Catch block.
* <code>version : [object Object]</code>
 
** <code>releaseIdx : 0</code>
==== Code Object ====
** <code>minor : 0</code>
* <code>AllowTextInput : Function(allow:Boolean):void</code>
** <code>major : 0</code>
* <code>GetMembers : Function():void</code>
** <code>beta : 0</code>
* <code>CallFunctionNoWait : Function():void</code>
* <code>UnmountImage : function Function() {}</code>
* <code>SendExternalEvent : Function(eventName:String, *...):void</code> Only the event name is required.
* <code>AllowTextInput : function Function(allow:Boolean) {}</code>
* <code>GetDirectoryListing : Function(path:String, match:String, recursive:Boolean):Array</code> Recursive may be an optional argument.
* <code>SendExternalEvent : function Function(eventName:String, argument:*) {}</code>
* <code>MountImage : Function(menuName:String, mountPath:String, mountName:String):void</code>
* <code>GetDirectoryListing : function Function() {}</code>
* <code>UnmountImage : Function(menuName:String, mountPath:String):void</code>
* <code>plugins : [object Object]</code>
* <code>plugins : [Object]</code>
** <code>f4mcm : [object Object]</code>
** <code>f4mcm : [Object]</code>
* <code>version : [Object]</code>
** <code>releaseIdx : Number</code>
** <code>minor : Number</code>
** <code>major : Number</code>
** <code>beta : Number</code>


== ExamineMenu ==
== ExamineMenu ==
* <code>SetName : function Function() {}</code>
* <code>SetName : Function():void</code>
* <code>ConfirmBuild : function Function() {}</code>
* <code>ConfirmBuild : Function():void</code>
* <code>PlaySound : function Function() {}</code>
* <code>PlaySound : Function():void</code>
* <code>ScrapItem : function Function() {}</code>
* <code>ScrapItem : Function():void</code>
* <code>StartBuildConfirm : function Function() {}</code>
* <code>StartBuildConfirm : Function():void</code>
* <code>SetItemSelectValuesForComponents : function Function() {}</code>
* <code>SetItemSelectValuesForComponents : Function():void</code>
* <code>FillModPartArray : function Function() {}</code>
* <code>FillModPartArray : Function():void</code>
* <code>OnAlternateButton : function Function() {}</code>
* <code>OnAlternateButton : Function():void</code>
* <code>HasNullMod : function Function() {}</code>
* <code>HasNullMod : Function():void</code>
* <code>ToggleFavoriteMod : function Function() {}</code>
* <code>ToggleFavoriteMod : Function():void</code>
* <code>IsSelectedItemEquipped : function Function() {}</code>
* <code>IsSelectedItemEquipped : Function():void</code>
* <code>UpdateItemSelectList : function Function() {}</code>
* <code>UpdateItemSelectList : Function():void</code>
* <code>ToggleItemEquipped : function Function() {}</code>
* <code>ToggleItemEquipped : Function():void</code>
* <code>RegisterComponents : function Function() {}</code>
* <code>RegisterComponents : Function():void</code>
* <code>RegisterRequirementList : function Function() {}</code>
* <code>RegisterRequirementList : Function():void</code>
* <code>SwitchMod : function Function() {}</code>
* <code>SwitchMod : Function():void</code>
* <code>ShowItem : function Function() {}</code>
* <code>ShowItem : Function():void</code>
* <code>StartAnimation : function Function() {}</code>
* <code>StartAnimation : Function():void</code>
* <code>ZoomIn : function Function() {}</code>
* <code>ZoomIn : Function():void</code>
* <code>HideMenu : function Function() {}</code>
* <code>HideMenu : Function():void</code>
* <code>SwitchBaseItem : function Function() {}</code>
* <code>SwitchBaseItem : Function():void</code>
* <code>UpdateRequirements : function Function() {}</code>
* <code>UpdateRequirements : Function():void</code>
* <code>SendTutorialEvent : function Function() {}</code>
* <code>SendTutorialEvent : Function():void</code>
* <code>RequestItemSelectListData : function Function() {}</code>
* <code>RequestItemSelectListData : Function():void</code>
* <code>RepairSelectedItem : function Function() {}</code>
* <code>RepairSelectedItem : Function():void</code>
* <code>CanRepairSelectedItem : function Function() {}</code>
* <code>CanRepairSelectedItem : Function():void</code>
* <code>CheckRequirements : function Function() {}</code>
* <code>CheckRequirements : Function():void</code>
* <code>StartItemSelection : function Function() {}</code>
* <code>StartItemSelection : Function():void</code>
* <code>EndRotate3DItem : function Function() {}</code>
* <code>EndRotate3DItem : Function():void</code>
* <code>RevertChanges : function Function() {}</code>
* <code>RevertChanges : Function():void</code>
* <code>RemoveHighlight : function Function() {}</code>
* <code>RemoveHighlight : Function():void</code>
* <code>OnBuildFailed : function Function() {}</code>
* <code>OnBuildFailed : Function():void</code>
* <code>CancelConfirm : function Function() {}</code>
* <code>CancelConfirm : Function():void</code>
* <code>ItemSelect : function Function() {}</code>
* <code>ItemSelect : Function():void</code>
* <code>ZoomOut : function Function() {}</code>
* <code>ZoomOut : Function():void</code>
* <code>StartRotate3DItem : function Function() {}</code>
* <code>StartRotate3DItem : Function():void</code>
* <code>ShouldShowTagForSearchButton : function Function() {}</code>
* <code>ShouldShowTagForSearchButton : Function():void</code>


== PipboyMenu ==
== PipboyMenu ==
* <code>PlaySound</code>                     <code>0</code>
* <code>PlaySound</code> <code>0</code>
* <code>PlaySmallTransition</code>           <code>1</code>
* <code>PlaySmallTransition</code> <code>1</code>
* <code>PopulatePipboyInfoObj</code>         <code>2</code>
* <code>PopulatePipboyInfoObj</code> <code>2</code>
* <code>onNewPage</code>                     <code>3</code>
* <code>onNewPage</code> <code>3</code>
* <code>onNewTab</code>                       <code>4</code>
* <code>onNewTab</code> <code>4</code>
* <code>toggleMovementToDirectional</code>   <code>0x28</code>
* <code>toggleMovementToDirectional</code> <code>0x28</code>
* <code>UseStimpak</code>                     <code>5</code>
* <code>UseStimpak</code> <code>5</code>
* <code>UseRadaway</code>                     <code>6</code>
* <code>UseRadaway</code> <code>6</code>
* <code>ShowPerksMenu</code>                 <code>7</code>
* <code>ShowPerksMenu</code> <code>7</code>
* <code>PlayPerkSound</code>                 <code>8</code>
* <code>PlayPerkSound</code> <code>8</code>
* <code>StopPerkSound</code>                 <code>9</code>
* <code>StopPerkSound</code> <code>9</code>
* <code>onPerksTabOpen</code>                 <code>0xA</code>
* <code>onPerksTabOpen</code> <code>0xA</code>
* <code>onPerksTabClose</code>               <code>0xB</code>
* <code>onPerksTabClose</code> <code>0xB</code>
* <code>SelectItem</code>                     <code>0xC</code>
* <code>SelectItem</code> <code>0xC</code>
* <code>onInvItemSelection</code>             <code>0xD</code>
* <code>onInvItemSelection</code> <code>0xD</code>
* <code>updateItem3D</code>                   <code>0xE</code>
* <code>updateItem3D</code> <code>0xE</code>
* <code>SetQuickkey</code>                   <code>0xF</code>
* <code>SetQuickkey</code> <code>0xF</code>
* <code>ItemDrop</code>                       <code>0x10</code>
* <code>ItemDrop</code> <code>0x10</code>
* <code>SortItemList</code>                   <code>0x11</code>
* <code>SortItemList</code> <code>0x11</code>
* <code>ExamineItem</code>                   <code>0x12</code>
* <code>ExamineItem</code> <code>0x12</code>
* <code>onComponentViewToggle</code>         <code>0x13</code>
* <code>onComponentViewToggle</code> <code>0x13</code>
* <code>ToggleComponentFavorite</code>       <code>0x14</code>
* <code>ToggleComponentFavorite</code> <code>0x14</code>
* <code>onShowHotKeys</code>                 <code>0x27</code>
* <code>onShowHotKeys</code> <code>0x27</code>
* <code>onQuestSelection</code>               <code>0x16</code>
* <code>onQuestSelection</code> <code>0x16</code>
* <code>SetQuestActive</code>                 <code>0x15</code>
* <code>SetQuestActive</code> <code>0x15</code>
* <code>ShowQuestOnMap</code>                 <code>0x17</code>
* <code>ShowQuestOnMap</code> <code>0x17</code>
* <code>ShowWorkshopOnMap</code>             <code>0x18</code>
* <code>ShowWorkshopOnMap</code> <code>0x18</code>
* <code>RegisterMap</code>                   <code>0x19</code>
* <code>RegisterMap</code> <code>0x19</code>
* <code>UnregisterMap</code>                 <code>0x1A</code>
* <code>UnregisterMap</code> <code>0x1A</code>
* <code>FastTravel</code>                     <code>0x1D</code>
* <code>FastTravel</code> <code>0x1D</code>
* <code>HasSetPlayerMarkerRequest</code>     <code>0x20</code>
* <code>HasSetPlayerMarkerRequest</code> <code>0x20</code>
* <code>SetPlayerMarker</code>               <code>0x21</code>
* <code>SetPlayerMarker</code> <code>0x21</code>
* <code>ClearPlayerMarker</code>             <code>0x22</code>
* <code>ClearPlayerMarker</code> <code>0x22</code>
* <code>onSwitchBetweenWorldLocalMap</code>   <code>0x23</code>
* <code>onSwitchBetweenWorldLocalMap</code> <code>0x23</code>
* <code>CenterMarkerRequest</code>           <code>0x24</code>
* <code>CenterMarkerRequest</code> <code>0x24</code>
* <code>onModalOpen</code>                   <code>0x25</code>
* <code>onModalOpen</code> <code>0x25</code>
* <code>CheckHardcoreModeFastTravel</code>   <code>0x1E</code>
* <code>CheckHardcoreModeFastTravel</code> <code>0x1E</code>
* <code>RefreshMapMarkers</code>             <code>0x1F</code>
* <code>RefreshMapMarkers</code> <code>0x1F</code>
* <code>ToggleRadioStationActiveStatus</code> <code>0x26</code>
* <code>ToggleRadioStationActiveStatus</code> <code>0x26</code>

Revision as of 19:07, 22 October 2018

These are my notes and findings about Actionscript 3 & Scaleform in Fallout 4.


F4SE

F4SE will install a code object to the root of any registered menu. To acquire the F4SE code object in AS3, use (stage.getChildAt(0) as MovieClip).f4se. It is a good idea to wrap calls to the F4SE code object in a Try/Catch block.

Code Object

  • AllowTextInput : Function(allow:Boolean):void
  • GetMembers : Function():void
  • CallFunctionNoWait : Function():void
  • SendExternalEvent : Function(eventName:String, *...):void Only the event name is required.
  • GetDirectoryListing : Function(path:String, match:String, recursive:Boolean):Array Recursive may be an optional argument.
  • MountImage : Function(menuName:String, mountPath:String, mountName:String):void
  • UnmountImage : Function(menuName:String, mountPath:String):void
  • plugins : [Object]
    • f4mcm : [Object]
  • version : [Object]
    • releaseIdx : Number
    • minor : Number
    • major : Number
    • beta : Number

ExamineMenu

  • SetName : Function():void
  • ConfirmBuild : Function():void
  • PlaySound : Function():void
  • ScrapItem : Function():void
  • StartBuildConfirm : Function():void
  • SetItemSelectValuesForComponents : Function():void
  • FillModPartArray : Function():void
  • OnAlternateButton : Function():void
  • HasNullMod : Function():void
  • ToggleFavoriteMod : Function():void
  • IsSelectedItemEquipped : Function():void
  • UpdateItemSelectList : Function():void
  • ToggleItemEquipped : Function():void
  • RegisterComponents : Function():void
  • RegisterRequirementList : Function():void
  • SwitchMod : Function():void
  • ShowItem : Function():void
  • StartAnimation : Function():void
  • ZoomIn : Function():void
  • HideMenu : Function():void
  • SwitchBaseItem : Function():void
  • UpdateRequirements : Function():void
  • SendTutorialEvent : Function():void
  • RequestItemSelectListData : Function():void
  • RepairSelectedItem : Function():void
  • CanRepairSelectedItem : Function():void
  • CheckRequirements : Function():void
  • StartItemSelection : Function():void
  • EndRotate3DItem : Function():void
  • RevertChanges : Function():void
  • RemoveHighlight : Function():void
  • OnBuildFailed : Function():void
  • CancelConfirm : Function():void
  • ItemSelect : Function():void
  • ZoomOut : Function():void
  • StartRotate3DItem : Function():void
  • ShouldShowTagForSearchButton : Function():void

PipboyMenu

  • PlaySound 0
  • PlaySmallTransition 1
  • PopulatePipboyInfoObj 2
  • onNewPage 3
  • onNewTab 4
  • toggleMovementToDirectional 0x28
  • UseStimpak 5
  • UseRadaway 6
  • ShowPerksMenu 7
  • PlayPerkSound 8
  • StopPerkSound 9
  • onPerksTabOpen 0xA
  • onPerksTabClose 0xB
  • SelectItem 0xC
  • onInvItemSelection 0xD
  • updateItem3D 0xE
  • SetQuickkey 0xF
  • ItemDrop 0x10
  • SortItemList 0x11
  • ExamineItem 0x12
  • onComponentViewToggle 0x13
  • ToggleComponentFavorite 0x14
  • onShowHotKeys 0x27
  • onQuestSelection 0x16
  • SetQuestActive 0x15
  • ShowQuestOnMap 0x17
  • ShowWorkshopOnMap 0x18
  • RegisterMap 0x19
  • UnregisterMap 0x1A
  • FastTravel 0x1D
  • HasSetPlayerMarkerRequest 0x20
  • SetPlayerMarker 0x21
  • ClearPlayerMarker 0x22
  • onSwitchBetweenWorldLocalMap 0x23
  • CenterMarkerRequest 0x24
  • onModalOpen 0x25
  • CheckHardcoreModeFastTravel 0x1E
  • RefreshMapMarkers 0x1F
  • ToggleRadioStationActiveStatus 0x26
Retrieved from "https://falloutck.uesp.net/w/index.php?title=User:Scrivener07/Menus&oldid=575"