WebLobby App

From Cinemar Wiki
Jump to: navigation, search

Do Not Use- Under Construction

About

WebLobby places an Internet Explorer browser directly within MainLobby. Users can position and size the browser window in Design Mode. While in Launch Mode, they can control and navigate the browser window.

Software Requirements

  • MainLobby 3.00.105 or higher
  • MLServer4
  • WebLobby MLServer App (installs in MLServer4)
  • LibraryWebLobby.swf (user interface components). File date 1/25/2008 or newer.

Installation

The WebLobby User Interface only needs to be installed on the MainLobby3 client machine. There is no need to install the WebLobby User Interface on the same system as MLServer4 unless there is a single system for both Mainlobby3 and MLServer4. However, the MLWebLobby MLServer4 App should be installed on the MLServer4 machine. It is important that MLWebLobby either be in trial mode or registered in order for the clients to display the WebLobby window.


Download and install WebLobby components via MLInstaller. Download to MLInstaller's configured Products directory.


  1. Follow the onscreen prompts paying attention to which PC each component gets installed to.
  2. This app installs with a 30 day trial period. Add your license key (available when you purchase WebLobby) to the Product Registation Manager in MLS4 and then Activate this App to your PC. You will get an email with an Activation code which you add to the same Registration window.


Quick Start

Upon install of MainLobby, some sample scenes are included help get you up and running right away. Load the scene entitled 0019_internet.mls.


Scene Design

  1. Launch MainLobby3
  2. Press NEW
  3. Locate your Cinemar folder and enter a scene name: myweblobby_scene.mls
  4. Press SAVE
  5. Move your mouse to the top of the screen to reveal the MainLobby Menu Bar
  6. Click on Library
  7. Select WEBLOBBY from the Library DropDown
  8. Press ADD
  9. Then click on the icon labeled MLWebWindow
    A WebWindow placeholder will appear while in Design or Edit Mode
  10. Press the X to close the Library Panel
  11. To Resize the WebWindow, place your mouse within the Red Square in the bottom right corner of the WebWindow placeholder and drag your mouse while holding down the left mouse button
  12. Now press LAUNCH Mode from the MainLobby menu bar to view the Internet Explorer Window
  13. By default, the MLWebWindow’s label field contains the following:
    100~100~http://www.cinemaronline.com~1
    Representing respectively: width~height~startupURL~ID


Creating Multiple WebLobby Windows

There may be cases where you wish to have multiple WebLobby windows appear on the same scene. This is easily done by specify a unique ID at the end of your label field. This ID should be a number such as 1, 2 or 3, etc. WebLobby Windows may not overlap and are always on top of all buttons on your scene.


Customizing the WebLobby Startup URL

By default, WebLobby’s startup URL is configured to http://www.cinemaronline.com however this link can be changed simply by editing the associated label field within that MLWebWindow object.


WebLobby Library

WebLobby comes with its own Library. This Library contains various URL textfield bars that can be added to your scene to allow users to manually enter a web address. The URL bar should be accompanied on the scene with a button that includes the Web.Navigate command.


Local Variables

Each MLWebWindow will create its own set of local variables based on the current webpage of that WebLobby Window. They are available to the client but not MLServer.

In combination with the InputText.LocalVar object, you can allow users to manually type in a URL and then add a GO button to your Scene. The MLServeCmd for the GO button would contain the following:

MLCmd|MLCommand~{{clientname}}~Web|Navigate~[[MLWebWindow1LocationURL]]

The variable within the double brackets are replaced by MainLobby and should appear in the command.

Notes

The Internet Explorer window uses Microsoft’s ActiveX, so it does not follow the standard Zorder that other objects in MainLobby follow. The Internet Explorer window is always on the top layer.

WebLobby Commands

Web|Close

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|Close~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|Close~1
MLCmd|MLCommand~myClient1~Web|Close~4


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Closes the Internet Explorer ActiveX window. Useful when changing scenes.


Notes
It is recommended to use this command as your Scene Exit MLServeCmd within MainLobby. This will remove the ActiveX window as you navigate to another scene. Otherwise, the ActiveX window will remain. These commands are case sensitive.



Web|GoBack

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|GoBack~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|GoBack~1
MLCmd|MLCommand~myClient1~Web|GoBack~3


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Navigates backward one item in the history list.


Web|GoForward

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|GoForward~ID


(Literal)

MLServeCmd.MLCmd|MLCommand~{{clientname}}~Web|GoForward~1 MLCmd|MLCommand~myClient1~Web|GoForward~2


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Navigates forward one item in the history list.

Notes


Web|GoHome

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|GoHome~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|GoHome~1
MLCmd|MLCommand~myClient1~Web|GoHome~3


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Navigates to the current home or start page as specified in the Internet Explorer Options dialogbox and Internet Control Panel – not your startup URL specified in the ini file.


Notes


Web|GoSearch

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|GoSearch~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|GoSearch~1
MLCmd|MLCommand~myClient1~Web|GoSearch~2


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Navigates to the current search page as specified in the Internet Explorer Options dialog box and Internet Control Panel.


Notes


Web|Hide

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|Hide~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|Hide~1
MLCmd|MLCommand~myClient1~Web|Hide~4


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Hides the web browser control window.


Notes


Web|Show

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|Show~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|Show~1
MLCmd|MLCommand~myClient1~Web|Show~2


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Shows the web browser control window.



Web|Navigate

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|Navigate~websiteurl~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|Navigate~http://www.cinemaronline.com~1
MLCmd|MLCommand~myClient1~Web|Navigate~http://www.google.com~2


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
websiteurl
=
URL to navigate to. (ie: http://www.cinemaronline.com)
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Navigates to the resource identified in the URL Bar.


Web|Stop

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|Stop~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|Stop~1
MLCmd|MLCommand~myClient1~Web|Stop~2


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations


Web|Refresh

{MLServeCmd}Script Usage

MLCmd|MLCommand~clientname~Web|Refresh~ID


(Literal)

MLCmd|MLCommand~{{clientname}}~Web|Refresh~1
MLCmd|MLCommand~myClient1~Web|Refresh~2


Parameters
clientname
=
Name of MainLobby Client. Sending {{clientname}} replaces {{clientname}} with actual name of the requesting client.
ID
=
Unique numeric identifier such as 1, 2 or 3 that targets the MLWebWindow with the same ID


Description
Reloads the page currently displayed in the WebBrowser control window


Tips:

Some charecters will not work in a URL. For those times, try pasting the following into a notepad document with a redirect.html type name and use that as the weblobby address. Replace URL line with whatever address you want.

<html> <head> <title>Redirect</title> <meta http-equiv="Refresh" content="0; URL=http://www.weather.com/weather/hourbyhour/12345? from=36hr_topnav_undeclared"> </head> <body bgcolor="#FFFFFF" text="#000000"> </body> </html>


Q: How would you close the browser if say you were using the automatic (timed)Reload Start Scene

A: MLServeCmd.MLCmd|MLCommand~{{clientname}}~Web|Close~1

Leave everything as shown above including {{clientname}} with curly brackets.

WebLobby Release Notes

How does it work?

After all files are placed in their proper location noted above, open MainLobby.

1) Open the sample "weblobby.mls" scene file (This will automatically load "weblobby.swf" into the BackgroundFX layer - although weblobby.swf can be loaded into any FX layer, we recommend the BackgroundFX layer when possible)

2) After opening the sample WebLobby Scene, you'll notice a white square pops in and then loads your default home page (If you are not in Launch mode, press the Launch button from the ML menu bar)

3) To move the WebBrowser control window around, press Design mode from the Menu bar. A substitute square pops in where the WebBrowser used to be.

4) Drag this square around. When you release it, WebLobby automatically saves the coordinates to weblobby.ini

5) In order to change the width and height of the WebBrowser window, you'll need to manually edit the weblobby.ini text file with Notepad. NOTE: The variables to change are WebLobbyBrowserWindowHeight and WebLobbyBrowserWindowWidth. They are default to a height of 520 pixels and a width of 800 pixels. Just change the number, leave everything else as is.


Assigning WebLobby commands to buttons

WebLobby introduces a variety of new commands to the ML Command Line found in your Button Properties Panel. Place MainLobby into Edit mode then select any button from the Stage. From the ML Command Line drop down, scroll down until you see the Web commands.

Note: Commands are case sensitive

- Web.Close : close the WebBrowser control window and ActiveX (Useful when changing scenes)

- Web.GoBack : navigates backward one item in the history list

- Web.GoForward : navigates forward one item in the history list

- Web.GoHome : navigates to the current home or start page, as specified in the Internet Explorer Options dialog box and Internet Control Panel

- Web.GoSearch : navigates to the current search page, as specified in the Internet Explorer Options dialog box and Internet Control Panel

- Web.Hide : hides the web browser control window

- Web.Navigate : navigates to the resource identified in the URL Bar

- Web.NavigateURL : navigates to the url specified in the MLcmd var: line (ie http://www.cinemaronline.com)

- Web.Refresh : reloads the page currently displayed in the WebBrowser control window

- Web.Show : shows the WebBrowser control window

- Web.Stop : cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations

Simply assign any of the above commands to any MainLobby button and it takes control over the WebBrowser window.


How do I change the URL bar?

WebLobby comes with it's own Library of objects. Press the Library button from the Menu Bar and select WebLobby from the drop down to view the current WebLobby objects available. There currently are three different URL bars avaiable. (Black text - no background, Black text - white background, white text - no background) As of now, you can not affect these variables and or fonts; however you can resize the objects as you would any other button within MainLobby.

Bugs