Script v1.7.1.0
- AI
- Animals
- Contracts
- Debug
- Economy
- Effects
- Events
- Farms
- GUI
- AnimalScreen
- AnimationElement
- BitmapElement
- BoxLayoutElement
- BreadcrumbsElement
- ButtonElement
- ButtonOverlay
- ChatWindow
- CheckedOptionElement
- ClearElement
- ContextActionDisplay
- DialogElement
- FieldInfoDisplay
- FillLevelsDisplay
- FlowLayoutElement
- FocusManager
- FrameElement
- FrameReferenceElement
- GameInfoDisplay
- GamePausedDisplay
- Gui
- GuiDataSource
- GuiElement
- GuiMixin
- GuiOverlay
- GuiProfile
- GuiSoundPlayer
- GuiTopDownCamera
- GuiUtils
- HUDDisplayElement
- HUDElement
- HUDFrameElement
- HUDPopupMessage
- HUDTextDisplay
- IndexChangeSubjectMixin
- IndexStateElement
- InGameIcon
- IngameMap
- IngameMapElement
- InputGlyphElement
- InputHelpDisplay
- ListElement
- ListItemElement
- MapHotspot
- MapOverlayGenerator
- MixerWagonHUDExtension
- MultiTextOptionElement
- MultiValueTween
- Overlay
- PagingElement
- PlaySampleMixin
- RenderElement
- RoundStatusBar
- ScreenElement
- SettingsModel
- SideNotification
- SliderElement
- SpeakerDisplay
- SpeedMeterDisplay
- StableListElement
- StatusBar
- TabbedMenu
- TabbedMenuFrameElement
- TabbedMenuWithDetails
- TableElement
- TableHeaderElement
- TextElement
- TextInputElement
- TimerElement
- ToggleButtonElement
- TopNotification
- Tween
- TweenSequence
- VehicleHUDExtension
- VehicleSchemaDisplay
- VideoElement
- 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
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- XML
- general
Foundation Reference
VehicleHUDExtension
DescriptionCustom vehicle HUD drawing extension. This serves as the base class for custom specific drawing cases of vehicles in the HUD, e.g. MixerWagon fill levels. To create new HUD extensions for vehicle specializations: 1. sub-class this base class 2. source() the sub-class module after its corresponding specialization's table has been declared 3. call VehicleHUDExtension.registerHUDExtension([specialization], [HUDextension]) in sub-class moduleFunctions
- addComponentForCleanup
- canDraw
- createHUDExtensionForSpecialization
- delete
- draw
- getDisplayHeight
- hasHUDExtensionForSpecialization
- new
- registerHUDExtension
addComponentForCleanup
DescriptionAdd a display component for cleanup on delete(). Added components must support delete() themselves or they will be ignored.Definition
addComponentForCleanup()Code
| 59 | function VehicleHUDExtension:addComponentForCleanup(component) |
| 60 | if component.delete then |
| 61 | table.insert(self.displayComponents, component) |
| 62 | end |
| 63 | end |
canDraw
DescriptionDetermine if this HUD extension is in a valid state for a call to draw() in the current frame. Override in sub-classes with custom logic.Definition
canDraw()Return Values
| bool | If | true, the HUD extension should be drawn in the current frame. |
| 76 | function VehicleHUDExtension:canDraw() |
| 77 | return true |
| 78 | end |
createHUDExtensionForSpecialization
DescriptionHUD extension factory method, creates a HUD extension for a given vehicle specialization.Definition
createHUDExtensionForSpecialization(table spec, table vehicle, float uiScale, table uiTextColor, float uiTextSize)Arguments
| table | spec | Specialization reference |
| table | vehicle | Vehicle which has the given specialization |
| float | uiScale | Current UI scale |
| table | uiTextColor | HUD text drawing color as an RGBA array |
| float | uiTextSize | HUD text size |
| table | HUD | extension instance or nil of no extension has been registered for the given specialization |
| 111 | function VehicleHUDExtension.createHUDExtensionForSpecialization(spec, vehicle, uiScale, uiTextColor, uiTextSize) |
| 112 | local extType = registry[spec] |
| 113 | local extension = nil |
| 114 | if extType then |
| 115 | extension = extType.new(vehicle, uiScale, uiTextColor, uiTextSize) |
| 116 | end |
| 117 | |
| 118 | return extension |
| 119 | end |
delete
DescriptionDelete this instance and clean up resources.Definition
delete()Code
| 49 | function VehicleHUDExtension:delete() |
| 50 | for k, component in pairs(self.displayComponents) do |
| 51 | component:delete() |
| 52 | self.displayComponents[k] = nil |
| 53 | end |
| 54 | end |
draw
DescriptionDraw HUD extension.Definition
draw(float leftPosX, float rightPosX, float posY)Arguments
| float | leftPosX | Left input help panel column start position |
| float | rightPosX | Right input help panel column start position |
| float | posY | Current input help panel drawing vertical offset |
| float | Modified | input help panel drawing vertical offset |
| 86 | function VehicleHUDExtension:draw(leftPosX, rightPosX, posY) |
| 87 | end |
getDisplayHeight
DescriptionGet this HUD extension's display height. Override in subclasses.Definition
getDisplayHeight()Code
| 68 | function VehicleHUDExtension:getDisplayHeight() |
| 69 | return 0 |
| 70 | end |
hasHUDExtensionForSpecialization
DescriptionCheck if there is a HUD extension for a given specialization.Definition
hasHUDExtensionForSpecialization()Code
| 123 | function VehicleHUDExtension.hasHUDExtensionForSpecialization(spec) |
| 124 | return not not registry[spec] |
| 125 | end |
new
DescriptionBase constructor for vehicle HUD extensions.Definition
new(table class_mt, table vehicle, float uiScale, table uiTextColor, float uiTextSize)Arguments
| table | class_mt | Sub-class metatable |
| table | vehicle | Vehicle which has the specialization required by a sub-class |
| float | uiScale | Current UI scale |
| table | uiTextColor | HUD text drawing color as an RGBA array |
| float | uiTextSize | HUD text size |
| 27 | function VehicleHUDExtension.new(class_mt, vehicle, uiScale, uiTextColor, uiTextSize) |
| 28 | if not class_mt or class_mt == VehicleHUDExtension then |
| 29 | class_mt = VehicleHUDExtension_mt |
| 30 | end |
| 31 | |
| 32 | local self = setmetatable({}, class_mt) |
| 33 | |
| 34 | -- vehicle specialization reference which provides the display data |
| 35 | self.vehicle = vehicle |
| 36 | |
| 37 | self.uiTextColor = uiTextColor |
| 38 | self.uiTextSize = uiTextSize |
| 39 | self.uiScale = uiScale |
| 40 | |
| 41 | -- array of created display components which need to be deleted |
| 42 | self.displayComponents = {} |
| 43 | |
| 44 | return self |
| 45 | end |
registerHUDExtension
DescriptionRegister a HUD extension for a specialization.Definition
registerHUDExtension(table specializationType, table hudExtensionType)Arguments
| table | specializationType | Vehicle specialization class type table |
| table | hudExtensionType | HUD extension class type table corresponding to the given vehicle specialization |
| 99 | function VehicleHUDExtension.registerHUDExtension(spec, hudExtensionType) |
| 100 | registry[spec] = hudExtensionType |
| 101 | end |