Creation
| |
| Storyboard | Creates a new Storyboard object |
|
Functions
| |
| Frame | |
| GetFrameWidth | Returns the width of the frame |
| GetFrameHeight | Returns the height of the frame |
|
| Scrolling | |
| Center | Centers the frame at a co-ordinate or object |
| CenterX | Centers the frame horizontally at a co-ordinate |
| CenterY | Centers the frame vertically at a co-ordinate |
| GetXScroll | Returns the current horizontal scroll position |
| GetYScroll | Returns the current vertical scroll position |
| GetXLeft | Returns the left-most point of the visible frame |
| GetYTop | Returns the top-most point of the visible frame |
| GetXRight | Returns the right-most point of the visible frame |
| GetYBase | Returns the bottom-most point of the visible frame |
|
| Count | |
| Count | Returns the total number of objects in the main game and GUI |
|
| Frame handling | |
| NewFrame | Creates a new frame in the project |
| SwapFrame | Swaps the current frame and plays any relevent transitions |
| RestartFrame | Restarts the current frame |
| NextFrame | Swaps to the next frame on the list |
| PreviousFrame | Swaps to the previous frame on the list |
| Restart | Restarts the game |
| GetCurrentFrame | Returns the index of the current frame |
| TryPassword | Checks a case-sensitive password and jumps to the relavent frame if it matches |
|
| Close | |
| Close | Ends the game |
|
| Callback | |
| StartOfGame | Called when the game starts |
| EndOfGame | Called when the game ends |
| OnMove | Called when the window is moved |
| OnMaximize | Called when the window is maximized |
| OnMinimize | Called when the window is minimized |
| OnSize | Called when the window is resized |
| OnDisplayChange | Called when the display changes |
| OnSetFocus | Called when the window gets focus |
| OnKillFocus | Called when the window looses focus |
|
| Collision mask | |
| IsClear | Returns TRUE if the given point is clear |
| IsObstacle | Returns TRUE if the given point is an obstacle |
| IsLadder | Returns TRUE if the given point is a ladder |
| IsPlatform | Returns TRUE if the given point is a platform |
| GetMaskValue | Returns the mask value at a given point |
|
| Full screen | |
| SetFullScreenMode | Sets the game to fullscreen |
| SetWindowedMode | Sets the game to windowed |
| IsFullScreen | Returns TRUE if the game is fullscreen |
