Widgets are objects in the game that help us display information (such as the Text widget) or interact with the player (such as the Dialog widget). Unlike the sprites, widgets are not affected by the game’s physics. Also unlike sprites, widgets are fixed to the camera - so no matter how the camera moves, a widget will be displayed in the same place. There are different types of widgets, each with its own properties and blocks.

When a widget is added, the definition of its event’s blocks already exist in the code. If code is not added to the blocks, then nothing will happen when the event occurs.

Most other widget functions are available to use in either the widget code section or a sprite code section. You will find these functions under the Widgets menu.

General Settings

All widgets have the following settings:

Shows the sprite or the widget.

Example

If this is written in the Timer widget, then the timer is shown.

Hides the sprite or the widget.

Example

If this is written in the Timer widget, then the timer is hidden.

The Counter widget is used to keep count. For example the score of the game or the number of lives that the player has left.

The Set counter block allows you to set the counter to a specific amount. Counter set blocks can be used in either a widget or a sprite code block.

Arguments

Example

Starts the game with a counter that equals 0. This is written in the Counter widget’s code.

This will change the specified counter by a specific amount. The amount can be either positive or negative, but will be added to the existing value. For example, if the current value is 3 and the change by amount is 2, the counter will be updated to 5.

This block can be used in either a widget or a sprite code block.

Arguments

Example

If this code was placed in a monkey sprite, the counter would increment up by 1 each time the monkey collides with the banana.

This block will return the current value of the counter so that it can be used elsewhere in the program.

This block can be used in either a widget or a sprite code block.

The counter is selected in the dropdown and the numerical value is returned.

Example

If this example was placed in a monkey sprite, the game would reset if the monkey collided with the banana and the counter value was equal to 0.

The Text widget is used to display labels or texts on the game’s screen.

This block sets the text to be displayed in the game.

This block can be used in either a widget or a sprite code block.

Properties

Examples

The string "Hello" will be displayed on the screen.

Note: the same block is used to set the text of the Text and Dialog widgets.

The Timer widget is used to time activities in the game. For example, if the game will run and end after x seconds. Or, for example, to set a time limit on a sprite’s special power.

When it gets to zero, the On End block will run.

The Set timer block is used to set the value of the timer. It will always count down and this will be the starting point from where it counts down. It can be set at the start of the program or elsewhere in the program.

This block can be used in either a widget or a sprite code block.

Arguments

Example

This code will set the timer to 10 seconds at the start of the program.

The On End block is called once the timer is up.

This block is defined in the widget and you will find the block in the widget code by default when the widget is created.

Example

Reset the timer to 5 when it end.

Tip

If you want to run the timer in a loop, add a Set time block in the On End block.

The Clock widget is used to show the elapsed time. It counts the elapsed seconds starting from 0 (as opposed to the timer that counts backwards until 0).

Starts the clock. Once the clock is started, it cannot be stopped.

Example

This will start the clock running as soon as the game starts.

Returns the number of seconds that have passed since the clock started running.

Returns

Number - number of seconds.

Example

If this is placed inside a banana sprite, the banana will be destroyed 5 seconds after the clock is started.

Use the Button widget to create a simple interface for your game. For example, to start the game by clicking on a Play button.

Properties

The On Down block is called when the button is pressed down. The block will be called repeatedly for as long as the button is pressed.

This block is defined in the widget and you will find the block in the widget code by default when the widget is created.

Example

In this example, for as long as the button is pressed down, the mySound sound will play.

The On Click block is called when the button is released (or clicked). This block will be called once.

This block is defined in the widget and you will find the block in the widget code by default when the widget is created.

Example

In this example, once the button is clicked (pushed down and released), the background will change to the road background.

The Dialog widget is used to display a message to the player. The message is a string.

Properties

The Set text block is used to update the text of the dialog box while the game is running.

This block can be used in either a widget or a sprite code block.

Arguments

Example

When the game is run, a dialog box will open with the text Click to start game.

Note: the same block is used to set the text of the Text and Dialog widgets.

The On Confirm block is called when the button on the dialog is clicked on.

This block is defined in the widget and you will find the block in the widget code by default when the widget is created.

Example

Start the clock when the player clicks on a dialog.

Relevant Articles:

Game Builder Guide

Game Builder Blocks - Sprites Tab

Game Builder Blocks - AI Extensions

Game Builder Blocks - Additional Features

Game Builder Blocks - Coding Concepts