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
SideNotification
DescriptionHUD side notification element. Displays notifications issued by other game components at the side of the screen.Parent
HUDDisplayElementFunctions
- addNotification
- createBackground
- createComponents
- draw
- getBackgroundPosition
- new
- setScale
- storeScaledValues
- update
- updateSizeAndPositions
addNotification
DescriptionAdd a notification message to display.Definition
addNotification(string text, table color, int displayDuration)Arguments
| string | text | Display message text |
| table | color | Color array as {r, g, b, a} |
| int | displayDuration | Display duration of message in milliseconds |
| 43 | function SideNotification:addNotification(text, color, displayDuration) |
| 44 | local notification = {text=text, color=color, duration=displayDuration, startDuration=displayDuration} |
| 45 | table.insert(self.notificationQueue, notification) |
| 46 | |
| 47 | self:updateSizeAndPositions() |
| 48 | end |
createBackground
DescriptionCreate the background overlay.Definition
createBackground()Code
| 167 | function SideNotification.createBackground(hudAtlasPath) |
| 168 | local posX, posY = SideNotification.getBackgroundPosition(1) |
| 169 | local width, height = getNormalizedScreenValues(unpack(SideNotification.SIZE.SELF)) |
| 170 | |
| 171 | local overlay = Overlay:new(hudAtlasPath, posX - width, posY - height, width, height) |
| 172 | overlay:setUVs(getNormalizedUVs(SideNotification.UV.DEFAULT_BACKGROUND)) |
| 173 | overlay:setColor(unpack(SideNotification.COLOR.DEFAULT_BACKGROUND)) |
| 174 | return overlay |
| 175 | end |
createComponents
DescriptionCreate required display components.Definition
createComponents()Code
| 179 | function SideNotification:createComponents(hudAtlasPath) |
| 180 | end |
draw
DescriptionDraw the notifications.Definition
draw()Code
| 79 | function SideNotification:draw() |
| 80 | if self:getVisible() and #self.notificationQueue > 0 then |
| 81 | SideNotification:superClass().draw(self) |
| 82 | |
| 83 | local baseX, baseY = self:getPosition() |
| 84 | local width, height = self:getWidth(), self:getHeight() |
| 85 | |
| 86 | local offsetX = 1 / g_screenWidth |
| 87 | local offsetY = 1 / g_screenHeight |
| 88 | local notificationX = baseX + width - self.notificationMarginX |
| 89 | local notificationY = baseY + height - self.textSize - self.notificationMarginY |
| 90 | |
| 91 | local _, _, _, alpha = self:getColor() |
| 92 | for i = 1, math.min(#self.notificationQueue, SideNotification.MAX_NOTIFICATIONS) do |
| 93 | local notification = self.notificationQueue[i] |
| 94 | |
| 95 | local fadeAlpha = 1 |
| 96 | if notification.startDuration - notification.duration < SideNotification.FADE_DURATION then |
| 97 | fadeAlpha = (notification.startDuration - notification.duration) / SideNotification.FADE_DURATION |
| 98 | elseif notification.duration < SideNotification.FADE_DURATION then |
| 99 | fadeAlpha = notification.duration / SideNotification.FADE_DURATION |
| 100 | end |
| 101 | |
| 102 | setTextBold(false) |
| 103 | setTextAlignment(RenderText.ALIGN_RIGHT) |
| 104 | -- render shadow |
| 105 | setTextColor(0, 0, 0, alpha * fadeAlpha) |
| 106 | renderText(notificationX + offsetX, notificationY - offsetY + self.textOffsetY, self.textSize, notification.text) |
| 107 | -- render text |
| 108 | setTextColor(notification.color[1], notification.color[2], notification.color[3], notification.color[4] * alpha * fadeAlpha) |
| 109 | renderText(notificationX, notificationY + self.textOffsetY, self.textSize, notification.text) |
| 110 | |
| 111 | notificationY = notificationY - self.textSize - self.lineOffset |
| 112 | end |
| 113 | end |
| 114 | end |
getBackgroundPosition
DescriptionGet this element's base background position.Definition
getBackgroundPosition(float uiScale)Arguments
| float | uiScale | Current UI scale factor |
| 124 | function SideNotification.getBackgroundPosition(uiScale) |
| 125 | local offX, offY = getNormalizedScreenValues(unpack(SideNotification.POSITION.SELF)) |
| 126 | return 1 - g_safeFrameOffsetX + offX * uiScale, 1 - g_safeFrameOffsetY + offY * uiScale -- top right corner plus offset |
| 127 | end |
new
DescriptionCreate a new SideNotification.Definition
new(string hudAtlasPath)Arguments
| string | hudAtlasPath | Path to the HUD atlas texture |
| table | SideNotification | instance |
| 24 | function SideNotification.new(hudAtlasPath) |
| 25 | local backgroundOverlay = SideNotification.createBackground(hudAtlasPath) |
| 26 | local self = SideNotification:superClass().new(SideNotification_mt, backgroundOverlay, nil) |
| 27 | |
| 28 | self.notificationQueue = {} -- i={text=<text>, color={r,g,b,a}, duration=<time in ms>} |
| 29 | |
| 30 | self.textSize = 0 |
| 31 | self.textOffsetY = 0 -- vertical alignment compensation offset |
| 32 | self.lineOffset = 0 |
| 33 | self.notificationMarginX, self.notificationMarginY = 0, 0 |
| 34 | |
| 35 | return self |
| 36 | end |
setScale
DescriptionSet uniform UI scale.Definition
setScale()Code
| 131 | function SideNotification:setScale(uiScale) |
| 132 | SideNotification:superClass().setScale(self, uiScale) |
| 133 | self:updateSizeAndPositions() |
| 134 | end |
storeScaledValues
DescriptionStore scaled positioning, size and offset values.Definition
storeScaledValues()Code
| 154 | function SideNotification:storeScaledValues() |
| 155 | self.textSize = self:scalePixelToScreenHeight(SideNotification.TEXT_SIZE.DEFAULT_NOTIFICATION) |
| 156 | self.textOffsetY = self.textSize * 0.15 |
| 157 | self.lineOffset = self.textSize * 0.3 |
| 158 | self.notificationMarginX, self.notificationMarginY = self:scalePixelToScreenVector(SideNotification.SIZE.NOTIFICATION_MARGIN) |
| 159 | end |
update
DescriptionUpdate notifications state.Definition
update()Code
| 56 | function SideNotification:update(dt) |
| 57 | local hasRemoval = false |
| 58 | for i = math.min(#self.notificationQueue, SideNotification.MAX_NOTIFICATIONS), 1, -1 do |
| 59 | local notification = self.notificationQueue[i] |
| 60 | if notification.duration <= 0 then |
| 61 | table.remove(self.notificationQueue, i) |
| 62 | hasRemoval = true |
| 63 | else |
| 64 | notification.duration = math.max(0, notification.duration - dt) -- limit to zero for alpha calculations |
| 65 | end |
| 66 | end |
| 67 | |
| 68 | if hasRemoval then |
| 69 | self:updateSizeAndPositions() |
| 70 | end |
| 71 | end |
updateSizeAndPositions
DescriptionUpdate sizes and positions of this elements and its children.Definition
updateSizeAndPositions()Code
| 138 | function SideNotification:updateSizeAndPositions() |
| 139 | local numLines = math.min(#self.notificationQueue, SideNotification.MAX_NOTIFICATIONS) |
| 140 | |
| 141 | local height = numLines * self.textSize + (numLines - 1) * self.lineOffset + self.notificationMarginY * 2 |
| 142 | local width = self:getWidth() |
| 143 | self:setDimension(width, height) |
| 144 | |
| 145 | local topRightX, topRightY = SideNotification.getBackgroundPosition(self:getScale()) |
| 146 | local bottomY = topRightY - self:getHeight() |
| 147 | self:setPosition(topRightX - width, bottomY) |
| 148 | |
| 149 | self:storeScaledValues() |
| 150 | end |