Script v1_7_1_0
- AI
- Animals
- Collections
- Contracts
- Debug
- Economy
- Elements
- EnvironmentalScore
- Errors
- Events
- GUI
- AnimalScreen
- AnimationElement
- BitmapElement
- BoxLayoutElement
- BreadcrumbsElement
- ButtonElement
- ButtonOverlay
- ChatWindow
- CheckedOptionElement
- ClearElement
- ColorPickButtonElement
- ConstructionScreen
- ContextActionDisplay
- ControlBarDisplay
- DialogElement
- DynamicFadedBitmapElement
- FillLevelsDisplay
- FlowLayoutElement
- FocusManager
- FrameElement
- FrameReferenceElement
- GameInfoDisplay
- GameInfoDisplayMobile
- GamePausedDisplay
- Gui
- GuiDataSource
- GuiElement
- GuiMixin
- GuiOverlay
- GuiProfile
- GuiSoundPlayer
- GuiTopDownCamera
- GuiTopDownCursor
- GuiUtils
- HUDDisplayElement
- HUDElement
- HUDFrameElement
- HUDPopupMessage
- HUDSliderElement
- HUDTextDisplay
- IndexChangeSubjectMixin
- IndexStateElement
- InfoDisplay
- InfoHUDBox
- InGameIcon
- IngameMap
- IngameMapElement
- InputGlyphElement
- InputGlyphElementUI
- InputHelpDisplay
- KeyValueInfoHUDBox
- ListElement
- ListItemElement
- MapOverlayGenerator
- MixerWagonHUDExtension
- MultiTextOptionElement
- MultiValueTween
- Overlay
- PagingElement
- PictureElement
- PlatformIconElement
- PlayerControlPadDisplay
- PlaySampleMixin
- RenderElement
- RoundStatusBar
- ScreenElement
- ScrollingLayoutElement
- SettingsModel
- SideNotification
- SideNotificationMobile
- SliderElement
- SpeakerDisplay
- SpeedMeterDisplay
- SpeedSliderDisplay
- StatusBar
- SteeringSliderDisplay
- TabbedMenu
- TabbedMenuFrameElement
- TabbedMenuWithDetails
- TableElement
- TableHeaderElement
- TerrainLayerElement
- TextBackdropElement
- TextElement
- TextInputElement
- ThreePartBitmapElement
- TimerElement
- ToggleButtonElement
- TopNotification
- Tween
- TweenSequence
- VariableWorkWidthHUDExten...
- VehicleHUDExtension
- VehicleSchemaDisplay
- VideoElement
- WardrobeScreen
- Handtools
- Hud
- I3d
- Input
- Jobs
- Maps
- Materials
- Misc
- Objects
- Parameters
- Placeables
- Placement
- Player
- Shop
- Sounds
- Specialization
- Specializations
- StateMachine
- Statistics
- Tasks
- Triggers
- Utils
- Vehicles
Engine v1_7_1_0
- AI
- Animation
- Camera
- Entity
- Fillplanes
- general
- General
- I3D
- Input
- Lighting
- Math
- Network
- Node
- NoteNode
- Overlays
- Particle System
- Physics
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- VoiceChat
- XML
Foundation Reference
TabbedMenuFrameElement
DescriptionBase class for frame elements for the in-game menu.Parent
FrameElementFunctions
- clearMenuButtonInfoDirty
- getHasCustomMenuButtons
- getMainElementPosition
- getMainElementSize
- getMenuButtonInfo
- initialize
- isMenuButtonInfoDirty
- new
- onFrameClose
- onFrameOpen
- requestClose
- setMenuButtonInfo
- setMenuButtonInfoDirty
- setTitle
clearMenuButtonInfoDirty
DescriptionClear menu button dirty flag.Definition
clearMenuButtonInfoDirty()Code
| 87 | function TabbedMenuFrameElement:clearMenuButtonInfoDirty() |
| 88 | self.menuButtonsDirty = false |
| 89 | end |
getHasCustomMenuButtons
DescriptionCheck if this menu frame requires menu button customization.Definition
getHasCustomMenuButtons()Code
| 54 | function TabbedMenuFrameElement:getHasCustomMenuButtons() |
| 55 | return self.hasCustomMenuButtons |
| 56 | end |
getMainElementPosition
DescriptionGet the frame's main content element's screen position.Definition
getMainElementPosition()Code
| 99 | function TabbedMenuFrameElement:getMainElementPosition() |
| 100 | return {0, 0} |
| 101 | end |
getMainElementSize
DescriptionGet the frame's main content element's screen size.Definition
getMainElementSize()Code
| 93 | function TabbedMenuFrameElement:getMainElementSize() |
| 94 | return {1, 1} |
| 95 | end |
getMenuButtonInfo
DescriptionGet custom menu button information.Definition
getMenuButtonInfo()Return Values
| table | Array | of button info as {i={inputAction= |
| 61 | function TabbedMenuFrameElement:getMenuButtonInfo() |
| 62 | return self.menuButtonInfo |
| 63 | end |
initialize
DescriptionLate initialization of a menu frame. Override in sub-classes.Definition
initialize()Code
| 49 | function TabbedMenuFrameElement:initialize(...) |
| 50 | end |
isMenuButtonInfoDirty
DescriptionGet the menu button info dirty state (has changed).Definition
isMenuButtonInfoDirty()Code
| 81 | function TabbedMenuFrameElement:isMenuButtonInfoDirty() |
| 82 | return self.menuButtonsDirty |
| 83 | end |
new
DescriptionCreate a new TabbedMenuFrameElement instance.Definition
new()Code
| 26 | function TabbedMenuFrameElement.new(target, customMt) |
| 27 | local self = FrameElement.new(target, customMt or TabbedMenuFrameElement_mt) |
| 28 | |
| 29 | self:registerControls(TabbedMenuFrameElement.CONTROLS) |
| 30 | |
| 31 | self.hasCustomMenuButtons = false |
| 32 | self.menuButtonInfo = {} |
| 33 | self.menuButtonsDirty = false |
| 34 | self.title = nil |
| 35 | self.tabbingMenuVisibleDirty = false |
| 36 | self.tabbingMenuVisible = true |
| 37 | self.currentPage = 1 |
| 38 | |
| 39 | self:setNumberOfPages(1) |
| 40 | |
| 41 | self.requestCloseCallback = NO_CALLBACK -- close request accepted callback |
| 42 | |
| 43 | return self |
| 44 | end |
onFrameClose
DescriptionCalled when this frame is closed by its container.Definition
onFrameClose()Code
| 125 | function TabbedMenuFrameElement:onFrameClose() |
| 126 | end |
onFrameOpen
DescriptionCalled when this frame is opened by its container.Definition
onFrameOpen()Code
| 115 | function TabbedMenuFrameElement:onFrameOpen() |
| 116 | self:updatePagingButtons() |
| 117 | |
| 118 | if GS_IS_MOBILE_VERSION and self.subPageSelector ~= nil and self.numberOfPages > 1 then |
| 119 | self:onPageChanged(self.currentPage, self.currentPage) |
| 120 | end |
| 121 | end |
requestClose
DescriptionRequest to close the frame. Frames can contain logic (e.g. saving pending changes) which should be handled before closing. Use this method in sub-classes request closing the frame so it can wrap up first. If a callback is provided and the initial request could not close the frame, the callback will be called as soon as the frame can be closed.Definition
requestClose()Code
| 108 | function TabbedMenuFrameElement:requestClose(callback) |
| 109 | self.requestCloseCallback = callback or NO_CALLBACK |
| 110 | return true |
| 111 | end |
setMenuButtonInfo
DescriptionSet custom menu button information.Definition
setMenuButtonInfo(table menuButtonInfo)Arguments
| table | menuButtonInfo | Array of button info as {i={inputAction= |
| 68 | function TabbedMenuFrameElement:setMenuButtonInfo(menuButtonInfo) |
| 69 | self.menuButtonInfo = menuButtonInfo |
| 70 | self.hasCustomMenuButtons = menuButtonInfo ~= nil |
| 71 | end |
setMenuButtonInfoDirty
DescriptionSet the menu button info dirty flag which causes the menu to update the buttons from this element's information.Definition
setMenuButtonInfoDirty()Code
| 75 | function TabbedMenuFrameElement:setMenuButtonInfoDirty() |
| 76 | self.menuButtonsDirty = true |
| 77 | end |
setTitle
DescriptionSet a new title for the frameDefinition
setTitle()Code
| 132 | function TabbedMenuFrameElement:setTitle(title) |
| 133 | self.title = title |
| 134 | if self.pagingTitle ~= nil then |
| 135 | self.pagingTitle:setText(title) |
| 136 | end |
| 137 | end |