Player

Use the built in player to test and debug your movies. Items that connect to the internet like video and pages will not show in the editor, unless selected in preferences.

Script

Fullscreen • Change the player or web browser to fullscreen mode. This feature requires a button or a link to work and will not work in the 'On Start' event.

Fullscreen(Show:Boolean);

Fullscreen Toggle • Toggle the player or web browser to fullscreen mode. This feature requires a button or a link to work and will not work in the 'On Start' event.

FullscreenToggle();

Debug • Add a message to the debugging list. This list can be viewed from the scene menu.

Debug("Message");

Get Movie Width • Returns the width of the movie without scaling.

GetMovieWidth();

Get Movie Height • Returns the height of the movie without scaling.

GetMovieHeight();

Get Left • Returns the left of the available space, in movie coordinates. This value will be zero, if the movie is clipped.

GetLeft();

Get Top • Returns the top of the available space, in movie coordinates. This value will be zero, if the movie is clipped.

GetTop();

Get Width • Returns the width of the available space, in movie coordinates. This value will be the movie width, if the movie is clipped.

GetWidth();

Get Height • Returns the height of the available space, in movie coordinates. This value will be the movie height, if the movie is clipped.

GetHeight();

These functions can be used to create responsive layouts. In this example, a grid and a viewer are positioned depending on whether the player is in portrait or landscape.

if(GetWidth()<GetHeight()){
Viewer.SetBounds(GetLeft(),GetTop(),GetWidth(),GetHeight()*.25);
Grid.SetBounds(GetLeft(),GetTop()+(GetHeight()*.25),GetWidth(),GetHeight()*.75);
}else{
Viewer.SetBounds(GetLeft(),GetTop(),GetWidth()*.75,GetHeight());
Grid.SetBounds(GetLeft()+(GetHeight()*.75),GetTop(),GetWidth()*.25,GetHeight());
}

Get Available Width • Returns the width of the available space. This will be the width of the 'Player' or the web page.

GetAvailableWidth();

Get Available Height • Returns the height of the available space. This will be the height of the 'Player' or the web page.

GetAvailableHeight();

Web Browser

Get URL • Navigate to a new URL or webpage. If the movie is in a frame then only the frame will change. Relative and absolute URLs are supported. For example GetUrl("http://www.Hippani.com").

GetUrl("http://");

Get Top URL • Navigate to a new URL or webpage in the main web browser. If the movie is in an iframe then the whole page, not just the iframe is navigated. Relative and absolute URLs are supported. For example GetTopUrl("http://www.Hippani.com").

GetTopUrl("http://");

Is Movie Top • Is the movie playing directly in the main web browser or is it in an iframe.

IsMovieTop();

Get New URL • Navigate to a new URL or webpage in a new window or tab of your web browser. Relative and absolute URLs are supported. For example GetNewUrl("http://www.Hippani.com").

GetNewUrl("http://");

Get IFrame URL • Navigate to a new URL or webpage in an iframe within the main browser. Relative and absolute URLs are supported. For example GetFrameUrl("Contents.html","ContentsFrame").

GetFrameUrl("http://","Frame Id");

Get Query String • Returns a query string value from the current URL. For example, if the current URL was http://www.MySite.com?Color=Red. GetQueryString('Color'); would return Red.

GetQueryString("Name");

Get E-Mail • Open the default e-mail client and to send an e-mail to the specified e-mail address.

GetEMail("Info@Hippani.!ScriptVariablecom");

Is Hippani • Is the movie playing in Hippani.

IsHippani();

Is Mobile • Is the web browser running on a mobile phone.

IsMobile();

Can Auto Play • The web browser can automatically play sounds and videos. Some browsers require user interaction before sounds and videos can be played.

CanAutoPlay();

Scroll By • Scroll the document by X,Y. This only works with horizontal and vertical document scales

ScrollBy(X:Number,Y:Number);

Scroll To • Scroll the document to X,Y. This only works with horizontal and vertical document scales

ScrollTo(X:Number,Y:Number);

Get Element • Get the document object model (DOM) element used to represent this object. This function is useful for extending HTML output. In the player this returns a Hippani element. Hippani elements support standard DOM methods, properties and attributes but are not connected to any other elements.
Note: Changing the style of an element will have little effect, as the style will be overwritten immediately by the timeline engine. Instead, try change the class or turning off the timeline for that object.

GetElement("Script ID");

//Example DOM inspector
var Element=GetElement("TestImage");
Element.setAttribute("test","Hello");
var Result="Element: "+Element.toString()+"\r\n";
Result+="nodeName: "+Element.nodeName+"\r\n";
Result+="Attribute test: "+Element.getAttribute("test")+"\r\n\r\n";
if(IsHippani()){
Result+="In Hippani Player\r\n";
}else{
Result+="In Web Browser\r\n";
Result+="id: "+Element.id+"\r\n";
Result+="class: "+Element.className+"\r\n";
Result+="style: "+Element.style.cssText+"\r\n";
}
alert(Result);

Cookies

Set Cookie • Set the value of a cookie. Cookies are used to save small pieces of data on your computer that can be retrieved in another session. Due to web browser limits, only 19 cookies can be saved at a maximum of 4095 bytes in length. The days parameter, is the number of days before the cookie expires.

SetCookie("Name","Text",Days:Number);

Get Cookie • Get the value of a cookie.

GetCookie("Name");

Remove Cookie • Removes a cookie.

RemoveCookie("Name");

Editor

Exporting