Module: BattleUI::GoingInOut

Overview

Module that implements the Going In & Out animation for each sprites/stacks of the UI

To work this module requires animation_handler to return a Yuki::Animation::Handler !

Instance Method Summary collapse

Instance Method Details

#animation_handler ⇒ Yuki::Animation::Handler{ Symbol => Yuki::AnimationMixin}

Get the animation handler



384
385
# File 'docs/5_Battle_01_Scene.rb', line 384

def go_in
end

#go_in

Tell the element to go into the scene



384
385
# File 'docs/5_Battle_01_Scene.rb', line 384

def go_in
end

#go_out(forced_delta = nil)

Tell the element to go out of the scene

Parameters:

  • forced_delta (Float) (defaults to: nil) —

    set the forced delta to force the animation to be performed with a specific delta



388
389
# File 'docs/5_Battle_01_Scene.rb', line 388

def go_out(forced_delta = nil)
end

#in? ⇒ Boolean

Note:

By default a UI element is considered as in because it's initialized in its in position

Tell if the UI element is in

Returns:

  • (Boolean)


393
394
# File 'docs/5_Battle_01_Scene.rb', line 393

def in?
end

#out? ⇒ Boolean

Tell if the UI element is out

Returns:

  • (Boolean)


397
398
# File 'docs/5_Battle_01_Scene.rb', line 397

def out?
end