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
DynamicFadedBitmapElement
DescriptionBitmap that has a list of images it fades between over timeParent
PictureElementFunctions
- canReceiveFocus
- copyAttributes
- delete
- draw
- getFocusTarget
- loadFromXML
- loadProfile
- new
- setAlpha
- setDisabled
- setImageFilenames
canReceiveFocus
DescriptionDefinitioncanReceiveFocus()Code
166 | function DynamicFadedBitmapElement:canReceiveFocus() |
167 | if not self.visible or #self.elements < 1 then |
168 | return false |
169 | end |
170 | -- element can only receive focus if all sub elements are ready to receive focus |
171 | for _, v in ipairs(self.elements) do |
172 | if (not v:canReceiveFocus()) then |
173 | return false |
174 | end |
175 | end |
176 | return true |
177 | end |
copyAttributes
DescriptionDefinitioncopyAttributes()Code
80 | function DynamicFadedBitmapElement:copyAttributes(src) |
81 | DynamicFadedBitmapElement:superClass().copyAttributes(self, src) |
82 | |
83 | GuiOverlay.copyOverlay(self.templateOverlay, src.templateOverlay) |
84 | self.filenames = table.copy(src.filenames) |
85 | |
86 | self.fadeTime = src.fadeTime |
87 | self.fadeInterval = src.fadeInterval |
88 | |
89 | self:buildOverlays() |
90 | end |
delete
DescriptionDefinitiondelete()Code
35 | function DynamicFadedBitmapElement:delete() |
36 | for _, overlay in ipairs(self.overlays) do |
37 | GuiOverlay.deleteOverlay(overlay) |
38 | end |
39 | GuiOverlay.deleteOverlay(self.templateOverlay) |
40 | |
41 | DynamicFadedBitmapElement:superClass().delete(self) |
42 | end |
draw
DescriptionDefinitiondraw()Code
144 | function DynamicFadedBitmapElement:draw(clipX1, clipY1, clipX2, clipY2) |
145 | local x, y, w, h = self:getAdjustedPosition() |
146 | local state = self:getOverlayState() |
147 | |
148 | local primaryIndex = self.currentImageIndex |
149 | local secondaryIndex = (primaryIndex % #self.filenames) + 1 |
150 | |
151 | local alpha = MathUtil.smoothstep(1 - (self.fadeTime / self.fadeInterval), 1, self.fadeAlpha) |
152 | local primaryFade = 1 |
153 | local secondaryFade = alpha -- crossfade |
154 | |
155 | self.overlays[primaryIndex].color[4] = primaryFade * self.alpha |
156 | GuiOverlay.renderOverlay(self.overlays[primaryIndex], x, y, w, h, state, clipX1, clipY1, clipX2, clipY2) |
157 | |
158 | if alpha > 0 then |
159 | self.overlays[secondaryIndex].color[4] = secondaryFade * self.alpha |
160 | GuiOverlay.renderOverlay(self.overlays[secondaryIndex], x, y, w, h, state, clipX1, clipY1, clipX2, clipY2) |
161 | end |
162 | end |
getFocusTarget
DescriptionDefinitiongetFocusTarget()Code
181 | function DynamicFadedBitmapElement:getFocusTarget() |
182 | if #self.elements > 0 then |
183 | local _, firstElement = next(self.elements) |
184 | if firstElement then |
185 | return firstElement |
186 | end |
187 | end |
188 | return self |
189 | end |
loadFromXML
DescriptionDefinitionloadFromXML()Code
46 | function DynamicFadedBitmapElement:loadFromXML(xmlFile, key) |
47 | DynamicFadedBitmapElement:superClass().loadFromXML(self, xmlFile, key) |
48 | |
49 | self.fadeTime = Utils.getNoNil(getXMLInt(xmlFile, key.."#fadeTime"), self.fadeTime) |
50 | self.fadeInterval = Utils.getNoNil(getXMLInt(xmlFile, key.."#fadeInterval"), self.fadeInterval) |
51 | |
52 | GuiOverlay.loadOverlay(self, self.templateOverlay, "image", self.imageSize, nil, xmlFile, key) |
53 | GuiOverlay.createOverlay(self.templateOverlay) |
54 | end |
loadProfile
DescriptionDefinitionloadProfile()Code
58 | function DynamicFadedBitmapElement:loadProfile(profile, applyProfile) |
59 | DynamicFadedBitmapElement:superClass().loadProfile(self, profile, applyProfile) |
60 | |
61 | self.fadeTime = profile:getNumber("fadeTime", self.fadeTime) |
62 | self.fadeInterval = profile:getNumber("fadeInterval", self.fadeInterval) |
63 | |
64 | local oldFilename = self.templateOverlay.filename |
65 | local oldPreviewFilename = self.templateOverlay.previewFilename |
66 | GuiOverlay.loadOverlay(self, self.templateOverlay, "image", self.imageSize, profile, nil, nil) |
67 | if oldFilename ~= self.templateOverlay.filename or oldPreviewFilename ~= self.templateOverlay.previewFilename then |
68 | GuiOverlay.createOverlay(self.templateOverlay) |
69 | end |
70 | |
71 | local filenameList = profile:getValue("imageFilenames") |
72 | if filenameList ~= nil then |
73 | self.filenames = filenameList:split(";") |
74 | self:buildOverlays() |
75 | end |
76 | end |
new
DescriptionDefinitionnew()Code
16 | function DynamicFadedBitmapElement.new(target, custom_mt) |
17 | local self = DynamicFadedBitmapElement:superClass().new(target, custom_mt or DynamicFadedBitmapElement_mt) |
18 | |
19 | self.templateOverlay = {} |
20 | self.fadeTime = 2500 |
21 | self.fadeInterval = 10000 |
22 | |
23 | self.alpha = 1 |
24 | self.filenames = {} |
25 | self.overlays = {} |
26 | |
27 | self.currentImageIndex = 1 |
28 | self.fadeAlpha = 0 |
29 | |
30 | return self |
31 | end |
setAlpha
DescriptionSet image alphaDefinition
setAlpha()Code
105 | function DynamicFadedBitmapElement:setAlpha(alpha) |
106 | DynamicFadedBitmapElement:superClass().setAlpha(self, alpha) |
107 | self.alpha = alpha |
108 | end |
setDisabled
DescriptionDefinitionsetDisabled()Code
94 | function DynamicFadedBitmapElement:setDisabled(disabled, doNotUpdateChildren) |
95 | DynamicFadedBitmapElement:superClass().setDisabled(self, disabled, doNotUpdateChildren) |
96 | if disabled then |
97 | self:setOverlayState(GuiOverlay.STATE_DISABLED) |
98 | else |
99 | self:setOverlayState(GuiOverlay.STATE_NORMAL) |
100 | end |
101 | end |
setImageFilenames
DescriptionSet the image filenameDefinition
setImageFilenames()Code
112 | function DynamicFadedBitmapElement:setImageFilenames(filenames) |
113 | self.filenames = filenames |
114 | self:buildOverlays() |
115 | end |