The hide method

Syntax:hide([TransitionObject transition])
Returns:nil

This method is used to make the sprite disappear from the screen.

Parameters

Type Name Description
TransitionObject transition Transition to use; se remarks for details

Remarks

If no transition is given, this one will be used by default:

{type=Transition.fade, time=0.3, block=false}

This method supports the following transition types:

  • Transition.none
  • Transition.fade

Examples

-- Create a Sprite object
ball = Sprite.new("ball.png", 1)

-- Make it appear on the screen
ball:show()

...

-- Stop showing the sprite on the screen
ball:hide()

-- Hide the sprite using a blocking fade transition with a duration of 5 seconds
ball:hide({type=Transition.fade, time=5, block=true})