SwapFrame
SwapFrame

Switches the current frame

bSuccess = myStoryboard.SwapFrame( Frame_Number, Fade, Fade_Duration )
bSuccess = myStoryboard.SwapFrame( Frame_Number )

Return value
TRUE if the frame was changed successfully, otherwise FALSE.

Parameters
  • Frame_Number
    A number corrisponding to the frame to switch to (0 based) Values returned by NewFrame are recomended.
  • Fade
    Optional fade object to override the frame's default fade
  • Fade_Duration
    Optional time to override the fade's default time
Comments

Swapping the frame changes which frame is currently playing. If applicable, a transition (or two) is played between the frames, then the new frame begins playing. Note that the frame will not be changed until the end of the current game loop. You may want to end the current loop early when changing the frame. To do this, use "Return Storyboard.SwapFrame()"

See also
Storyboard:NewFrame
Storyboard:NextFrame
Storyboard:PreviousFrame
Storyboard:RestartFrame
Storyboard:Restart



JAM © 2005 no one in partiular
Project started by David Evans in 2005