Difference between revisions of "User:Scrivener07/Menus"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(Added a note)
imported>Qazaaq
Line 1: Line 1:
These are my notes and findings about Actionscript 3 & Scaleform in Fallout 4.
These are my notes and findings about Actionscript 3 & Scaleform in Fallout 4.
== F4SE ==
[[:Category:F4SE|F4SE]] will install a code object to the root of any registered menu.
To acquire the F4SE code object in AS3, use <code>(stage.getChildAt(0) as MovieClip).f4se</code> or <code>MovieClip(root).f4se</code>..
There are some cases when the installed F4SE code object on a menu root may be unreachable from your display object class.
With [[:Category:F4SE|F4SE]] v0.6.8 and greater the code object may be received by implementing the <code>onF4SEObjCreated</code> function on your display object class.
This function is called on the menu root document as well as first-level children.
<source lang="actionscript">
package Shared.F4SE
{
public interface ICodeObject
{
function onF4SEObjCreated(codeObject:*):void;
}
}
</source>


==== Code Object ====
==== Code Object ====

Revision as of 22:51, 26 November 2018

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

Code Object

It is a good idea to wrap calls to the F4SE code object in a Try/Catch block.

  • 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 : Array
    • f4mcm : [Object]
  • version : [Object]
    • releaseIdx : Number
    • minor : Number
    • major : Number
    • beta : Number

ExamineMenu

BGSCodeObj

  • 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

BGSCodeObj

  • 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