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
ClearElement
DescriptionDisplay element for images. Used layers: "image" for the display image.XML Configuration Parameters
| GuiElement#offset | string [optional] Position offset of the displayed image relative to this element's origin in reference resolution, defaults to [0, 0]. Format: "[x]px [y]px". |
| GuiElement#focuseOffset | string [optional] Position offset of the displayed image when it's focused, pressed, highlighted or selected. Works like #offset. |
Functions
- applyBitmapAspectScale
- applyScreenAlignment
- canReceiveFocus
- copyAttributes
- delete
- draw
- getFocusTarget
- getOffset
- loadFromXML
- loadProfile
- new
- setDisabled
- setImageRotation
applyBitmapAspectScale
DescriptionDefinitionapplyBitmapAspectScale()Code
| 73 | function ClearElement:applyBitmapAspectScale() |
| 74 | local xScale, yScale = self:getAspectScale() |
| 75 | |
| 76 | self.offset[1] = self.offset[1] * xScale |
| 77 | self.focusedOffset[1] = self.focusedOffset[1] * xScale |
| 78 | |
| 79 | self.offset[2] = self.offset[2] * yScale |
| 80 | self.focusedOffset[2] = self.focusedOffset[2] * yScale |
| 81 | end |
applyScreenAlignment
DescriptionDefinitionapplyScreenAlignment()Code
| 85 | function ClearElement:applyScreenAlignment() |
| 86 | self:applyBitmapAspectScale() |
| 87 | |
| 88 | ClearElement:superClass().applyScreenAlignment(self) |
| 89 | end |
canReceiveFocus
DescriptionDefinitioncanReceiveFocus()Code
| 134 | function ClearElement:canReceiveFocus() |
| 135 | if not self.visible or #self.elements < 1 then |
| 136 | return false |
| 137 | end |
| 138 | -- element can only receive focus if all sub elements are ready to receive focus |
| 139 | for _, v in ipairs(self.elements) do |
| 140 | if (not v:canReceiveFocus()) then |
| 141 | return false |
| 142 | end |
| 143 | end |
| 144 | return true |
| 145 | end |
copyAttributes
DescriptionDefinitioncopyAttributes()Code
| 63 | function ClearElement:copyAttributes(src) |
| 64 | ClearElement:superClass().copyAttributes(self, src) |
| 65 | |
| 66 | GuiOverlay.copyOverlay(self.overlay, src.overlay) |
| 67 | self.offset = table.copy(src.offset) |
| 68 | self.focusedOffset = table.copy(src.focusedOffset) |
| 69 | end |
delete
DescriptionDefinitiondelete()Code
| 31 | function ClearElement:delete() |
| 32 | GuiOverlay.deleteOverlay(self.overlay) |
| 33 | |
| 34 | ClearElement:superClass().delete(self) |
| 35 | end |
draw
DescriptionDefinitiondraw()Code
| 124 | function ClearElement:draw(clipX1, clipY1, clipX2, clipY2) |
| 125 | local xOffset, yOffset = self:getOffset() |
| 126 | |
| 127 | clearOverlayArea(self.absPosition[1]+xOffset, self.absPosition[2]+yOffset, self.size[1], self.size[2], self.overlay.rotation, self.size[1]/2, self.size[2]/2) |
| 128 | |
| 129 | ClearElement:superClass().draw(self, clipX1, clipY1, clipX2, clipY2) |
| 130 | end |
getFocusTarget
DescriptionDefinitiongetFocusTarget()Code
| 149 | function ClearElement:getFocusTarget() |
| 150 | local _, firstElement = next(self.elements) |
| 151 | if firstElement then |
| 152 | return firstElement |
| 153 | end |
| 154 | return self |
| 155 | end |
getOffset
DescriptionDefinitiongetOffset()Code
| 104 | function ClearElement:getOffset() |
| 105 | local xOffset, yOffset = self.offset[1], self.offset[2] |
| 106 | local state = self:getOverlayState() |
| 107 | if state == GuiOverlay.STATE_FOCUSED or state == GuiOverlay.STATE_PRESSED or state == GuiOverlay.STATE_SELECTED or GuiOverlay.STATE_HIGHLIGHTED then |
| 108 | xOffset = self.focusedOffset[1] |
| 109 | yOffset = self.focusedOffset[2] |
| 110 | end |
| 111 | return xOffset, yOffset |
| 112 | end |
loadFromXML
DescriptionDefinitionloadFromXML()Code
| 39 | function ClearElement:loadFromXML(xmlFile, key) |
| 40 | ClearElement:superClass().loadFromXML(self, xmlFile, key) |
| 41 | |
| 42 | GuiOverlay.loadOverlay(self, self.overlay, "clear", self.imageSize, nil, xmlFile, key) |
| 43 | self.focusedOffset = GuiUtils.getNormalizedValues(getXMLString(xmlFile, key.."#focusedOffset"), self.outputSize, self.focusedOffset) |
| 44 | self.offset = GuiUtils.getNormalizedValues(getXMLString(xmlFile, key.."#offset"), self.outputSize, self.offset) |
| 45 | end |
loadProfile
DescriptionDefinitionloadProfile()Code
| 49 | function ClearElement:loadProfile(profile, applyProfile) |
| 50 | ClearElement:superClass().loadProfile(self, profile, applyProfile) |
| 51 | |
| 52 | GuiOverlay.loadOverlay(self, self.overlay, "clear", self.imageSize, profile, nil, nil) |
| 53 | self.offset = GuiUtils.getNormalizedValues(profile:getValue("offset"), self.outputSize, self.offset) |
| 54 | self.focusedOffset = GuiUtils.getNormalizedValues(profile:getValue("focusedOffset"), self.outputSize, {self.offset[1], self.offset[2]}) |
| 55 | |
| 56 | if applyProfile then |
| 57 | self:applyBitmapAspectScale() |
| 58 | end |
| 59 | end |
new
DescriptionDefinitionnew()Code
| 20 | function ClearElement.new(target, custom_mt) |
| 21 | local self = GuiElement.new(target, custom_mt or BitmapElement_mt) |
| 22 | |
| 23 | self.offset = {0,0} |
| 24 | self.focusedOffset = {0,0} |
| 25 | self.overlay = {} |
| 26 | return self |
| 27 | end |
setDisabled
DescriptionDefinitionsetDisabled()Code
| 93 | function ClearElement:setDisabled(disabled, doNotUpdateChildren) |
| 94 | ClearElement:superClass().setDisabled(self, disabled, doNotUpdateChildren) |
| 95 | if disabled then |
| 96 | self:setOverlayState(GuiOverlay.STATE_DISABLED) |
| 97 | else |
| 98 | self:setOverlayState(GuiOverlay.STATE_NORMAL) |
| 99 | end |
| 100 | end |
setImageRotation
DescriptionSet this element's image overlay's rotation.Definition
setImageRotation(float rotation)Arguments
| float | rotation | Rotation in radians |
| 118 | function ClearElement:setImageRotation(rotation) |
| 119 | self.overlay.rotation = rotation |
| 120 | end |