clickable_add_ext

Creates a clickable DOM icon outside of the canvas element with custom scale and alpha.

Syntax:

GML Code Example

clickable_add_ext(x, y, tpe, url, target, params, scale, alpha);


Argument Description
x The x position within the window.
y The y position within the window.
tpe The texture page entry for the sprite to be used (use sprite_get_tpe).
url The URL (website address) to link to, or the script to be run.
target This is the target area to open the URL in (see description).
params The various parameters for the icon (see description).
scale The scale of the icon (default 1).
alpha The image alpha of the icon (default 1).


Returns: Real


Description

With this function you can create a custom, clickable, icon that acts as a "button" outside of the game canvas, but within the browser window itself. The function will return an id value which must be stored in a variable to be used in all further button functions that reference the new icon. This function is very useful to prevent the browser creating a pop-up window when clicking on the button as it is all done through GameMaker: Studio itself.

This function works exactly the same as the clickable_add function, where you must set the position relative to the (0,0) of the browser window, give the texture page entry for the sprite you wish the button icon to have (see: sprite_get_tpe), specify either a URL to open or a script (from the resource tree of GameMaker: Studio) to be opened or run then set the target and parameters to use. However this function also has two additional options that permit you to set the icon alpha from 0 (fully transparent) to 1 (fully opaque) and the scale of the icon, which is a multiplier value applied to the sprite used. So a value of 1 is the default scale, while (for example) 0.5 would be half scale and 2 would be double.

It is also worth noting that if the URL argument you pass in is the name of a script (ie: it doesn't start with "http://") AND the script is called gmcallback_* then you can get direct feeds into an html5 event. GameMaker: Studio function names are not obfuscated if they begin with gmcallback_.


Example:

GML Code Example

home_but = clickable_add_ext(32, 32, sprite_get_tpe(spr_MS_Home, 0), "http://macsweeney_games.com", "_blank", "width=700, height=500, menubar=0, toolbar=0, scrollbars=0", 2, 1);

The above code creates a clickable DOM icon at the position (32, 32) of the page that the game canvas is running on. The icon uses the sprite referenced from the texture page as "spr_MS_Home" and when clicked the icon will open a new window for the specified URL and with the defined properties for that window. the button will also be scaled to twice the original sprite size and half an image alpha of 1.


Back: HTML5



No Examples Submitted

Does this page need better examples? Be the first to Submit

No Edits Suggested

Is this page unclear or not descriptive enough? Suggest an edit to the page and with enough upvotes your changes will be made.

No Questions Have Been Ask

Do you have a question about this page? Ask it Here