object:toFront()

Type Function
Object DisplayObject
Library display.*
Return value none
Revision Current Public Release (2014.2381)
Keywords toFront, draw order
See also object:toBack()

Overview

Moves the target object to the visual front of its parent group (object.parent).

Gotchas

This also affects the order of the objects in the parent group array.

Syntax

object:toFront()

Example

-- This sample creates a group of display objects (playing cards).
-- Clicking on one of the cards sends it to the top of the parent group's visual stack.

local cards = display.newGroup()     

function bringToFront( event )
    if ( event.phase == "began" ) then
        event.target:toFront()
    end
    return true
end

for i=1,5 do
    local cardGroup = display.newGroup()

    -- Card outline
    local cardRect = display.newRoundedRect( 100, 100, 125, 175, 12 )
    cardRect.strokeWidth = 2
    cardRect:setFillColor( 1 )    
    cardRect:setStrokeColor( 0, 0, 0, 0.3 )
    cardGroup:insert(cardRect)

    -- Card values
    local cardValue = display.newText( cardGroup, i, cardRect.contentWidth - 72, 32, native.systemFontBold, 24 )
    cardValue:setFillColor( 1, 0, 0 )
    local cardValue2 = display.newText( cardGroup, i, 148, cardRect.contentHeight - 8 , native.systemFontBold, 24 )
    cardValue2:setFillColor( 1, 0, 0 )       

    cardGroup.x = (i * 25)
    cardGroup.y = (i * 25)
    cards:insert( cardGroup )

    cardGroup:addEventListener( "touch", bringToFront )
end