Script v1.7.1.0
- AI
- Animals
- Contracts
- Debug
- Economy
- Effects
- Events
- Farms
- GUI
- Handtools
- I3d
- Materials
- Misc
- Objects
- Placeables
- Player
- Shop
- Sounds
- Specializations
- Triggers
- Utils
- Vehicles
- Weather
Engine v1.7.1.0
- AI
- Animation
- Camera
- Entity
- Fillplanes
- General
- I3D
- Input
- Lighting
- Math
- Network
- Node
- Overlays
- Particle System
- Physics
- JointConstructor:setActors
- JointConstructor:setJointTransforms
- addDifferential
- addForce
- addImpulse
- addTorque
- addTorqueImpulse
- addVehicleLink
- computeWheelShapeTireForces
- createCCT
- createWheelShape
- getAngularDamping
- getAngularVelocity
- getCCTCollisionFlags
- getCenterOfMass
- getCollisionMask
- getDensity
- getLinearDamping
- getLinearVelocity
- getMass
- getMotorRotationSpeed
- getRigidBodyType
- getVelocityAtLocalPos
- getVelocityAtWorldPos
- getVolume
- getWheelShapeAxleSpeed
- getWheelShapeContactForce
- getWheelShapeContactNormal
- getWheelShapeContactObject
- getWheelShapeContactPoint
- getWheelShapePosition
- getWheelShapeSlip
- moveCCT
- overlapBox
- overlapSphere
- raycastAll
- raycastClosest
- removeCCT
- setAngularDamping
- setAngularVelocity
- setCenterOfMass
- setCollisionMask
- setFrictionVelocity
- setJointDrive
- setLinearDamping
- setLinearVelocity
- setMass
- setRigidBodyType
- setSolverIterationCount
- setWheelShapeForcePoint
- setWheelShapeProps
- setWheelShapeTireFriction
- simulatePhysics
- simulatePhysicsTimeScale
- updateDifferential
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- XML
- general
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
clearMenuButtonInfoDirty
DescriptionClear menu button dirty flag.Definition
clearMenuButtonInfoDirty()Code
71 | function TabbedMenuFrameElement:clearMenuButtonInfoDirty() |
72 | self.menuButtonsDirty = false |
73 | end |
getHasCustomMenuButtons
DescriptionCheck if this menu frame requires menu button customization.Definition
getHasCustomMenuButtons()Code
38 | function TabbedMenuFrameElement:getHasCustomMenuButtons() |
39 | return self.hasCustomMenuButtons |
40 | end |
getMainElementPosition
DescriptionGet the frame's main content element's screen position.Definition
getMainElementPosition()Code
83 | function TabbedMenuFrameElement:getMainElementPosition() |
84 | return {0, 0} |
85 | end |
getMainElementSize
DescriptionGet the frame's main content element's screen size.Definition
getMainElementSize()Code
77 | function TabbedMenuFrameElement:getMainElementSize() |
78 | return {1, 1} |
79 | end |
getMenuButtonInfo
DescriptionGet custom menu button information.Definition
getMenuButtonInfo()Return Values
table | Array | of button info as {i={inputAction= |
45 | function TabbedMenuFrameElement:getMenuButtonInfo() |
46 | return self.menuButtonInfo |
47 | end |
initialize
DescriptionLate initialization of a menu frame. Override in sub-classes.Definition
initialize()Code
33 | function TabbedMenuFrameElement:initialize(...) |
34 | end |
isMenuButtonInfoDirty
DescriptionGet the menu button info dirty state (has changed).Definition
isMenuButtonInfoDirty()Code
65 | function TabbedMenuFrameElement:isMenuButtonInfoDirty() |
66 | return self.menuButtonsDirty |
67 | end |
new
DescriptionCreate a new TabbedMenuFrameElement instance.Definition
new()Code
17 | function TabbedMenuFrameElement:new(target, customMt) |
18 | local self = FrameElement:new(target, customMt or TabbedMenuFrameElement_mt) |
19 | |
20 | self.hasCustomMenuButtons = false |
21 | self.menuButtonInfo = {} |
22 | self.menuButtonsDirty = false |
23 | self.title = nil |
24 | |
25 | self.requestCloseCallback = NO_CALLBACK -- close request accepted callback |
26 | |
27 | return self |
28 | end |
onFrameClose
DescriptionCalled when this frame is closed by its container.Definition
onFrameClose()Code
104 | function TabbedMenuFrameElement:onFrameClose() |
105 | end |
onFrameOpen
DescriptionCalled when this frame is opened by its container.Definition
onFrameOpen()Code
99 | function TabbedMenuFrameElement:onFrameOpen() |
100 | 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
92 | function TabbedMenuFrameElement:requestClose(callback) |
93 | self.requestCloseCallback = callback or NO_CALLBACK |
94 | return true |
95 | end |
setMenuButtonInfo
DescriptionSet custom menu button information.Definition
setMenuButtonInfo(table menuButtonInfo)Arguments
table | menuButtonInfo | Array of button info as {i={inputAction= |
52 | function TabbedMenuFrameElement:setMenuButtonInfo(menuButtonInfo) |
53 | self.menuButtonInfo = menuButtonInfo |
54 | self.hasCustomMenuButtons = menuButtonInfo ~= nil |
55 | 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
59 | function TabbedMenuFrameElement:setMenuButtonInfoDirty() |
60 | self.menuButtonsDirty = true |
61 | end |