Construct 3 icon

Construct 3

Documentation

iframe

Published 13 Nov, 2018
562 words
~2-4 mins

The iframe object can display another web page, or a string of some HTML content, in your project. It is named after the <iframe> element, which is what the object uses.

This object can also be used to show embedded content, such as YouTube videos. For example if you choose to share a YouTube video and select the "embed" option, it provides some HTML code for an iframe element. The src attribute is the embed URL for the video, e.g. https://www.youtube.com/embed/pWiC5Ln_0yA. This can be used in the URL property of Construct's iframe object to show the video in your game.

iframe properties

URL

The URL of a web page to load inside the iframe.

HTML content

A string of HTML content to display inside the iframe. This loads the HTML locally and does not request a separate web page. This is only used if the URL property is left empty.

Initially visible

Whether the object is initially visible at runtime.

ID

An optional id attribute to set on the iframe element. This may be useful if you have other styles or JavaScript code that you want to use with the iframe.

Allow

An optional feature policy string to set in the iframe's allow attribute, which specifies what the displayed page is allowed to do. The default is designed to allow embedded video playback on services like YouTube, granting the video permission to enter fullscreen, autoplay, and use encrypted media.

Enable sandbox

Sandbox

Check Enable sandbox to add the sandbox attribute on the iframe element, providing enhanced security. The Sandbox property is then the string to use in the sandbox attribute. Enabling the sandbox starts by removing a wide range of capabilities, and then each capability can be re-enabled by adding it to the sandbox string. By default the sandbox string allows JavaScript execution, but blocks forms, popups, same-origin access, top-document navigation, and more. If you only display static HTML content, you can also remove the default allow-scripts to block any JavaScript execution at all. For more information see the iframe sandbox attribute on MDN.

iframe conditions

The iframe object does not have any of its own conditions.

iframe actions

Set CSS style

Set a custom CSS style on the iframe element by setting a CSS property and its value.

Display HTML string

Load a string of HTML content in the iframe. This is similar to using the HTML content property. If the iframe was previously displaying a URL, it will switch to the HTML content instead.

Navigate to URL

Load a new URL in the iframe. If the iframe was previously displaying a string of HTML, it will switch to loading this URL instead.

iframe expressions

The iframe object does not have any of its own expressions.