Animação flip-book

Uma animação flip-book consiste em uma série de imagens estáticas exibidas em sequência. A técnica é muito semelhante à animação tradicional em célula (veja http://en.wikipedia.org/wiki/Traditional_animation). Ela oferece possibilidades ilimitadas, já que cada frame pode ser manipulado individualmente. Porém, como cada frame é armazenado em uma imagem única, o uso de memória pode ser alto. A suavidade da animação também depende do número de imagens exibidas por segundo, mas aumentar o número de imagens normalmente também aumenta a quantidade de trabalho. Animações flip-book do Defold são armazenadas como imagens individuais adicionadas a um Atlas, ou como um Tile Source com todos os frames organizados em uma sequência horizontal.

Reproduzindo animações flip-book

Sprites e nodes GUI do tipo box podem reproduzir animações flip-book, e você tem bastante controle sobre elas em tempo de execução.

Sprites

Para executar uma animação em tempo de execução, use a função sprite.play_flipbook(). Veja um exemplo abaixo.

Nodes GUI do tipo box

Para executar uma animação em tempo de execução, use a função gui.play_flipbook(). Veja um exemplo abaixo.

Exemplo de sprite

Suponha que seu jogo tenha um recurso de “dodge” que permite ao jogador pressionar um botão específico para esquivar. Você criou quatro animações para dar feedback visual ao recurso:

“idle”

Uma animação em loop do personagem do jogador parado.

“dodge_idle”

Uma animação em loop do personagem do jogador parado enquanto está em posição de esquiva.

“start_dodge”

Uma animação de transição executada uma vez, levando o personagem do jogador da posição em pé para a esquiva.

“stop_dodge”

Uma animação de transição executada uma vez, levando o personagem do jogador da esquiva de volta para a posição em pé.

O script a seguir fornece a lógica:

local function play_idle_animation(self)
    if self.dodge then
        sprite.play_flipbook("#sprite", hash("dodge_idle"))
    else
        sprite.play_flipbook("#sprite", hash("idle"))
    end
end

function on_input(self, action_id, action)
    -- "dodge" é nossa ação de entrada
    if action_id == hash("dodge") then
        if action.pressed then
            sprite.play_flipbook("#sprite", hash("start_dodge"), play_idle_animation)
            -- lembra que estamos esquivando
            self.dodge = true
        elseif action.released then
            sprite.play_flipbook("#sprite", hash("stop_dodge"), play_idle_animation)
            -- não estamos mais esquivando
            self.dodge = false
        end
    end
end

Exemplo de node GUI do tipo box

Ao selecionar uma animação ou imagem para um node, você na verdade atribui a fonte da imagem (atlas ou tile source) e a animação padrão de uma vez. A fonte da imagem é definida estaticamente no node, mas a animação atual a reproduzir pode ser alterada em tempo de execução. Imagens estáticas são tratadas como animações de um frame, então alterar uma imagem em tempo de execução equivale a reproduzir uma animação flip-book diferente no node:

function init(self)
    local character_node = gui.get_node("character")
    -- Isso exige que o node tenha uma animação padrão no mesmo atlas ou tile source que
    -- a nova animação/imagem que estamos reproduzindo.
    gui.play_flipbook(character_node, "jump_left")
end

Callbacks de conclusão

As funções sprite.play_flipbook() e gui.play_flipbook() aceitam uma função callback Lua opcional como último argumento. Essa função será chamada quando a animação terminar de reproduzir. A função nunca é chamada para animações em loop. O callback pode ser usado para disparar eventos ao concluir a animação ou para encadear várias animações. Exemplos:

local function flipbook_done(self)
    msg.post("#", "jump_completed")
end

function init(self)
    sprite.play_flipbook("#character", "jump_left", flipbook_done)
end

local function flipbook_done(self)
    msg.post("#", "jump_completed")
end

function init(self)
    gui.play_flipbook(gui.get_node("character"), "jump_left", flipbook_done)
end