NewFrame
NewFrame

Adds a new frame to the project

index = myStoryboard.NewFrame( Start_Function, Code_Function, End_Function, Fade_In, Fade_In_Time, Fade_Out, Fade_Out_Time, Password )
index = myStoryboard.NewFrame( Start_Function, Code_Function, End_Function, Fade_In, Fade_In_Time, Password )
index = myStoryboard.NewFrame( Start_Function, Code_Function, End_Function, Password )

Return value
The index of the created frame, or -1 if unsuccessfull.

Parameters
  • Start_Function
    Function to be called when the frame begins. It is called just before the fade starts, and it is recomended for setting up level objects, etc.
  • Code_Function
    Function to be called repeatedly while the frame is running. This should control the game objects
  • End_Function
    Function to be called when the frame ends (level changes or game ends) This is run just before the fade out, and is recomended for cleaning up (note that objects do NOT need to be deleted)
  • Fade_In
    Fade object to use for a fade in for the level. See the Fades General Details for more information
  • Fade_In_Time
    Time (in milliseconds) to display the fade in
  • Fade_Out
    Fade object to use for a fade out for the level
  • Fade_Out_Time
    Time (in milliseconds) to display the fade out
  • Password
    Password for use with TryPassword and the game menu
Comments

You can ommit any parameter. Note that the password given will be case-sensitive ONLY IF a part of it is in capitals. If it is entirely lower case, it is case-insensitive.
In the functions, you should declare objects and variables with the This. keyword (i.e. This.Var1 = 2;) to make them accessable from other functions

See also
Storyboard:SwapFrame



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