Storyboard Controls

Author
Status	Released
Release Date	Unknown
Last Updated	{{{LastUpdated}}}
Available for	Not yet documented
Supported Runtimes
License	Free
Attributes	{{{Attributes}}}
Download
Includes Examples	No
Includes Help Files	Yes
Links	Included by default.
Alternates	{{{Alternates}}}

The Storyboard Controls object starts and ends your Clickteam Fusion 2.5 applications, allows your applications to jump between frames, and controls scrolling. You can use the storyboard controls to change the flow of your application by jumping to the next or previous frame or restarting a frame from the beginning. The storyboard controls also let you change how the frame scrolls across the screen. For example, if you create a scrolling game, you can set the scrolling options to scroll with the Player object so that the player is always visible on the screen.

The Storyboard Controls object is a system object and is only available in the Event editor.

Conditions

Start of frame

The Start Of Frame condition tests to see if the application is at the start of a frame. This allows you to set up your application to perform specific actions at the beginning of a frame. Any action inserted in the Start Of Frame event line is only performed once, and is performed ahead of all other actions in the frame.

End of frame

The End Of Frame condition tests to see if the end of a frame has been reached. This allows you set up your applications to perform specific actions upon moving to the next frame.

End of application

The End Of application condition is true only for a short period of time, when the application quits. It allows you to perform specific tasks (like closing files) and do cleanup before leaving.

End of Pause

This condition is TRUE when the application quits the PAUSE mode. This is a one-shot condition.

Frame position has just been loaded

This condition is true the loop just after the position of the frame has been loaded with the load frame position or load application position actions.

Frame position has just been saved

This condition is true the loop just after the position of the frame has been saved with the save frame position action.

Is V-Sync Enabled

The Is V-Sync Enabled condition is true if the display is synchronized with the screen refresh. You can enable or disable this option either in the properties of the application, or with the V-Sync On/Off actions.

Collision Mask

Is Obstacle

Tests the collision mask for the presence of an obstacle at the given X and Y coordinates. This condition is true when the coordinates lay over an obstacle.

Is Ladder

Tests the collision mask for the presence of a ladder at the given X and Y coordinates. This condition is true when the coordinates lay over a ladder.

Actions

Next frame

The Next Frame action jumps to the next frame in the application. If you use this action on the last frame of the application, it automatically ends the application.

Previous frame

The Previous Frame action jumps to the previous frame in the application.

Jump to frame

The Jump To Frame action jumps to a specific frame in the application. You can also use the Expression Evaluator to jump to a frame number indicated by a function or formula.

Restart the current frame

The Restart The Current Frame action restarts the current frame. All values will be reset and any unsaved information within the application will be lost.

Restart the application

The Restart The application action restarts the application. All values will be reset and any unsaved information within the application will be lost.

End the application

The End The application action ends the application.

Frame position

The Frame Position actions allow you to save and restore the position of a frame or an application.

Save frame position

Asks for a file name. It saves the current frame position in the file.

Load application position

Asks for a filename. It restores the application as it was when it was changed. The current frame may be changed.

Load frame position

Asks for a filename. It restores the current frame as it was when saved.

Demo

The demo action allows you to play a demo previously recorded. All the keypresses, joystick movements, and mouse movements and clicks will be simulated. If you play your frame at exactly the same time you recorded it, it will play exactly the same. It is recommended that you use this action in a Start of frame event.

Play demo file

Asks for a filename. Plays the given demo file. All keyboard and mouse input done by the user will have no effect until the end of the demo.

Pause application

These actions allow you to pause an application from within the events.

Pause and resume when a key is pressed

Asks for a key. It pauses the application and resumes it when a specific key is pressed.

Pause and resume when any key is pressed

Pauses the application and resumes it when any key is pressed.

Scrollings

The Scrollings actions let you scroll the frame in different ways. The Scrollings actions are:

Center window position in frame

Centers the view of the frame about specific coordinates or about the coordinates of a specific object.

Center horizontal position of window in frame

Centers the horizontal position of the frame about a specific horizontal (X) coordinate or the X coordinate of another object.

Center vertical position of window in frame

Centers the vertical position of the frame about a specific vertical (Y) coordinate or the Y coordinate of another object.

Frame

Set width

Allows you to modify the width of the frame. Note: if the virtual width is equal to the width of the frame, it's modified as well.

Set height

Allows you to modify the height of the frame. Note: if the virtual height is equal to the height of the frame, it's modified as well.

Set virtual width

Allows you to modify the virtual width of the frame. Refer to the documentation of the Virtual Width property for more information.

Set virtual height

Allows you to modify the virtual height of the frame. Refer to the documentation of the Virtual Height property for more information.

Set Background Color

Allows you to change the background color of the frame.

Effect

Set effect

No info available, please add some!

Set effect parameter

No info available, please add some!

Set effect image parameter

No info available, please add some!

Set alpha-blending coefficient

No info available, please add some!

Set RGB coefficient

No info available, please add some!

Backdrops

Delete Created Backdrops At

Allows you to delete all the backdrop objects that are at given coordinates and have been created with the Add Backdrop action of the Active object or with the Create Backdrop action of the Active Picture object. Parameters = layer index (1-based), X and Y coordinates of the position to test, and fine (1) or box (0) detection mode. In box detection mode, a backdrop object is deleted if the X, Y coordinates are inside its bounding box. In fine detection mode, a backdrop object is deleted if there is a non-transparent pixel at the X, Y coordinates.

Delete All Created Backdrops

Allows you to delete all the backdrop objects that have been created with the Add Backdrop action of the Active object or with the Create Backdrop action of the Active Picture object. Parameter = layer index (1-based).

Screen

Clear Screen

Clears the entire screen with a given color. Warning, a scrolling will restore the screen.

Clear Zone

Clears a specific area of the screen with a given color. Warning, a scrolling will restore the screen.

Full Screen Mode

Switches the display to full-screen and displays the current window zoomed to the new screen resolution. This action works better when the window of your game has one of the standard sizes: 320x200, 640x480, 800x600, 1024x768, etc. Note: the Full-Screen Mode and Windowed Mode actions do not work if the Direct X display mode is selected in the application / Runtime properties.

Windowed mode

Switches back to normal windowed mode if the application was in full screen.

V-Sync

On

Enables the synchronization of the display with the screen refresh.

Off

Disables the synchronization of the display with the screen refresh.

Set Frame Rate

This action allows you to change the frame rate of the application. The frame rate is the number of application loops that are executed per second.

Expressions

Current number of frame

frame

The Current Number Of Frame function retrieves the number of the current frame displayed in the application.

Current number of players playing

players

The Current Number Of Players Playing function retrieves the number of players in a game.

Frame

Width

Frame Width

Retrieves the width of the frame.

Height

Frame Height

Retrieves the height of the frame.

Virtual Width

VirtualWidth

Retrieves the virtual width of the frame.

Virtual Height

VirtualHeight

Retrieves the virtual height of the frame.

X coordinate of left visible edge

X Left Frame

Retrieves the horizontal (X) coordinate of the leftmost visible edge of the frame.

X coordinate of right visible edge

X Right Frame

Retrieves the horizontal (X) coordinate of the rightmost visible edge of the frame.

Y coordinate of top visible edge

Y Top Frame

Retrieves the vertical (Y) coordinate of the top-most visible edge of the frame.

Y coordinate of bottom visible edge

Y Bottom Frame

Retrieves the vertical (Y) coordinate of the bottom-most visible edge of the frame.

Background color

FrameBkdColor

Retrieves the RGB value of the background color of the frame.

Value of collision mask

CollisionMask(>Enter X coordinate<, >Enter Y coordinate<)

This function asks for two parameters: X and Y position of the pixel to test. It returns 2 if the given pixel is located over a ladder, 1 if the given pixel is located over an obstacle and 0 if the pixel is located on a free area.

Effect

Alpha-blending coefficient

FrameAlphaCoef

No info available, please add some!

RGB coefficient

FrameRGBCoef

No info available, please add some!

Effect parameter

FrameEffectParam(> Enter string here <)

No info available, please add some!

Screen

Display mode

DisplayMode

No info available, please add some!

Pixel shader version

PixelShaderVersion

No info available, please add some!

Number Of Frames per Second

FrameRate

This function retrieves the frame rate of your application. This is the desired frame rate entered in the application properties or set by the Set Frame Rate action, this is not the real frame rate, which may depends on the machine on which is executed your application.

Contributors to this page

Advaith (100.0%)