ScreenElement

ScreenElement

Description

Base screen element. All full-screen GUI views inherit from this. ScreenElement inherits from FrameElement and has no additional configuration, but contains UI logic shared across all full screen views.

Parent

FrameElement

Functions

• canReceiveFocus
• getIsOpen
• initializeScreen
• inputEvent
• invalidateScreen
• new
• onClose
• onOpen
• setNextScreenClickSoundMuted
• setReturnScreenClass

canReceiveFocus

Description

Definition

canReceiveFocus()

Code

function ScreenElement:canReceiveFocus()
    if not self.visible then
        return false
    end

    -- element can only receive focus if all sub elements are ready to receive focus
        for i = 1 , # self.elements do
            if not self.elements[i]:canReceiveFocus() then
                return false
            end
        end

        return true
    end

getIsOpen

Description

Definition

getIsOpen()

Code

function ScreenElement:getIsOpen()
    return self.isOpen
end

initializeScreen

Description

Definition

initializeScreen()

Code

function ScreenElement:initializeScreen()
    self.isInitialized = true

    if self.pageSelector ~ = nil and self.pageSelector.disableButtonSounds ~ = nil then
        -- disable click sounds for page selector buttons, we use the paging sound in separate screen logic
            self.pageSelector:disableButtonSounds()
        end
    end

inputEvent

Description

Definition

inputEvent()

Arguments

any	action
any	value
any	eventUsed

Code

function ScreenElement:inputEvent(action, value, eventUsed)
    eventUsed = ScreenElement:superClass().inputEvent( self , action, value, eventUsed)

    if self.inputDisableTime < = 0 then
        -- handle special case for screen paging controls:
            if self.pageSelector ~ = nil and(action = = InputAction.MENU_PAGE_PREV or action = = InputAction.MENU_PAGE_NEXT) then
                if action = = InputAction.MENU_PAGE_PREV then
                    self:onPagePrevious()
                elseif action = = InputAction.MENU_PAGE_NEXT then
                        self:onPageNext()
                    end
                    -- always consume event to avoid triggering any other focused elements
                    eventUsed = true
                end

                if not eventUsed then
                    local focusElement = FocusManager:getFocusedElement()
                    local nameAction = g_inputBinding.nameActions[action]
                    if focusElement ~ = nil and nameAction:getNumActiveBindings() > 0 then
                        if action = = InputAction.MENU_LIST_PAGE_START then
                            if focusElement.scrollToStart ~ = nil then
                                focusElement:scrollToStart()
                                eventUsed = true
                            end
                        elseif action = = InputAction.MENU_LIST_PAGE_END then
                                if focusElement.scrollToEnd ~ = nil then
                                    focusElement:scrollToEnd()
                                    eventUsed = true
                                end
                            end

                            if action = = InputAction.MENU_LIST_PAGE_PREV then
                                if focusElement.scrollToPrevPage ~ = nil then
                                    focusElement:scrollToPrevPage()
                                    eventUsed = true
                                end
                            elseif action = = InputAction.MENU_LIST_PAGE_NEXT then
                                    if focusElement.scrollToNextPage ~ = nil then
                                        focusElement:scrollToNextPage()
                                        eventUsed = true
                                    end
                                end

                                if action = = InputAction.MENU_LIST_PAGE_START_GAMEPAD then
                                    if focusElement.scrollToStartGamepad ~ = nil then
                                        focusElement:scrollToStartGamepad()
                                        eventUsed = true
                                    end
                                elseif action = = InputAction.MENU_LIST_PAGE_END_GAMEPAD then
                                        if focusElement.scrollToEndGamepad ~ = nil then
                                            focusElement:scrollToEndGamepad()
                                            eventUsed = true
                                        end
                                    end
                                end
                            end

                            if not eventUsed then
                                -- Directly access screen element subclass events by button presses.The abstract implementation of these
                                -- methods in this class return true, so that we can evaluate if there is no concrete implementation.In
                                    -- that case, the event must not be consumed.
                                    eventUsed = ScreenElement.callButtonsWithAction( self.elements, action)
                                end
                            end

                            return eventUsed
                        end

invalidateScreen

Description

Definition

invalidateScreen()

Code

function ScreenElement:invalidateScreen()
end

new

Description

Definition

new()

Arguments

any	target
any	custom_mt

Code

function ScreenElement.new(target, custom_mt)
    local self = FrameElement.new(target, custom_mt or ScreenElement _mt)

    self.isBackAllowed = true
    self.handleCursorVisibility = true
    self.returnScreenClass = nil
    self.isOpen = false
    self.lastMouseCursorState = false
    self.isInitialized = false
    self.nextClickSoundMuted = false

    return self
end

onClose

Description

Definition

onClose()

Code

function ScreenElement:onClose()
    if self.handleCursorVisibility then
        g_inputBinding:setShowMouseCursor( self.lastMouseCursorState)
    end

    self.isOpen = false
end

onOpen

Description

Definition

onOpen()

Code

function ScreenElement:onOpen()
    if not self.isInitialized then
        self:initializeScreen()
    end

    self.lastMouseCursorState = g_inputBinding:getShowMouseCursor()
    g_inputBinding:setShowMouseCursor( true )

    self.isOpen = true
end

setNextScreenClickSoundMuted

Description

Mute the next click sound. Used to override click sounds for the activate/cancel actions

Definition

setNextScreenClickSoundMuted()

Arguments

any	value

Code

function ScreenElement:setNextScreenClickSoundMuted(value)
    if value = = nil then
        value = true
    end
    self.nextClickSoundMuted = value
end

setReturnScreenClass

Description

Set the class of the return screen which should be opened when the "back" action is triggered on this screen.

Definition

setReturnScreenClass()

Arguments

any	returnScreenClass

Code

function ScreenElement:setReturnScreenClass(returnScreenClass)
    self.returnScreenClass = returnScreenClass
end