Class MacaoPage

The class MacaoPage is not a class itself, but it is used to document the global properties and methods of the package core/storageManager.js.

This field keeps the path from the current page to the Macao base directory. It is strongly recommended to set this field before loading the Java Script libraries.

The Macao base directory is defined as the directory, which contains the subdirectory named core. For example, if you have your HTML page file in the in the subdirectory "myapp", set this field to "../". If you have your page in the subdirectory "myapp/chapter1", set this field to "../../" and so on.

Call this method to add an inventory item to the Storage Manager.

This method is used by the inventory controller to store its items to the Storage Manager. If you want to add an inventory item during the game, you should instead send an event calling to invoke the method MacaoInventory.addInventoryItem(). Call this method, if you want to initialize the inventory during the start of a new game.

If you call this method from a page, you should call the method MacaoPage.isStorageBlocked() to check, if the write access to the Storage Manager is allowed.

Parameters

inventoryName: Provide the name of the inventory. This is usually the name of the MacaoInventory controller object, which is used to display the inventory.
itemName: Provide the name of the inventory item.
itemTitle: Provide the title of the inventory item, which will be used to build sentences with the item.
imageUrl: Provide the URL of the image, which will be displayed for the inventory item. The URL is relative to the base path.
itemSubtitle: Provide the subtitle, which is displayed under the item image. The subtitle may contain placeholders vor the display of the quantity. Provide null, if there is no subtitle to be displayed.
quantity: Provide the quantity of the item. Provide 0, if there is no quantity to be maintained for this item.

Call this method to remove all items of an inventory from the Storage Manager.

Call this method before adding items using the method addInventoryItem().

Parameters

inventoryName: Provide the name of the inventory. This is usually the name of the MacaoInventory controller object, which is used to display the inventory.

Use this method to define the texts of a text resource in one or more languages.

You may provide texts for as much languages as you like by providing more parameters. The text in the parameters has to fit the languages, which are defined using the method setResourceDefinitionLanguages(). You have to call that method first.

See defResource() and getResource() for descriptions and examples.

Parameters

resourceName: Provide the name of the resource, which texts are to be defined.
language1Text: Provide the text for the first definition language.
language2Text: Provide the text for the second definition language. You may add more parameters for additional languages.

Use this method to get the base path.

The base path is the relative path between the location of the current page and the Macao base directory. Use this path, if you calculate an image source location. See also setBasePath() and basePath. See getBasePath() for an example.

Returns

Returns the relative path between the location of the current page and the Macao base directory.

Call this method to get the definitions of all items of an inventory from the Storage Manager.

Parameters

inventoryName: Provide the name of the inventory. This is usually the name of the MacaoInventory controller object, which is used to display the inventory.


Returns

This method returns an array with the items. Each item has the following properties:
name: String. The name of the item.
title: String. The title of the item, which is to be displayed to the user.
imageUrl: String. The URL of the image relative to the base path.
subtitle: String. The text, which is to be displayed below the image. This property contains null, if there is no subtitle to be displayed.
quantity: float. The quantity of the item.
If the inventory has no items or there is no such inventory defined, an empty array is returned.

Call this method to get the actual language of the application.

The language can be set with the URL, which is used to open the page containing the storage manager. Provide the language as the parameter "language". The default language is en (= English). The following URL defines the language de (= German) as the actual language.

http://www.mydomain.com/macao/myapp.html?language=de

Returns

Returns the actual language code. The default language code is "en" for English.

This method calculates the name of the page from the page's filename, by removing the extension.

If the page has the filename "page1.html", then the method returns "page1".

Returns

Returns the name of the page.

Call this method to get the value of a parameter, which is provided with the URL, which was used to open the page.

Parameters

parameterName: Provide the name of the parameter.


Returns

Returns the value of the parameter. Returns null, if there was no parameter with the specified name.

Call this method to get the parameters, which are provided with the URL.

Returns

The method returns an array with the parameters. The array is indexed by the parameter's names. The items of the array are containing the parameter's values as strings.

Use this method to get the content of a text resource for the actual language.

The actual language can be set using the method setLanguageSM() or the URL parameter language. See getResource() for a description.

Parameters

resourceName: The name of the resource, which text you ask for.
defaultLanguageText: Provide the text for the resource in the resource default language. The resource default language is set using the method setResourceDefaultLanguage(). Provide null, if you want this resource only to be defined in a central place.
nullIfUndefined: Set this parameter to false, if you want to get the resource name, when the resource text for the actual language is not defined. Set this parameter to true, if you want to get null, when the text for the actual language is not defined.


Returns

Returns the text of the resource for the actual language. Returns null respectively the name of the resource, if the text is not defined for the actual language.

Call this method to check, if the design mode is active.

Returns

Returns true, if the design mode is active. Returns false, if the design mode is not active.

This method opens a dialog window to export the text resources.

Use this dialog to create the source code for additional languages and the translations of additional resources. You can copy the source code to your page and fill in the translations. See also getResource() and defResource().

You may use this method to set the base path.

But it's recommended to set the base path before loading the first JavaScript package into the page. So you better set the variable basePath directly before loading this package. See basePath and getBasePath(). See getBasePath() for an example.

Parameters

path: Provide the relative path between the location of the current page and the Macao base directory.

Call this method to set the design mode active or inactive.

By default the design mode is active.

When the design mode is active, the user can drag objects with the mouse while holding the Shift and Control key down. If the keys are hold down and the mouse is moved, the position of the mouse is displayed in the status bar. The user can also open the Road Editor hitting the key E, when the design mode is active.

Parameters

active: Provide true to activate the design mode. Provide false to deactivate the design mode.

Call this method to set the actual language of the application.

The default language is "en" for English.

Parameters

language: Provide the language code, which is to be used as the actual language.

This method sets the language, which is used by the parameter defaultLanguageText of the method getResource().

See getResource(). See getResource() for a description.

Parameters

language: Provide a language code like "en", "de", "fr" etc.

This method sets the languages, which are used by the method defResource() to define resource texts.

See also defResource(). See defResource() for a description.

Parameters

languagesArray: Provide an array of strings containing the language codes, which are used to define the resources.

Call this method to get a game event from the storage manager.

Parameters

eventName: Provide the name of the game event.


Returns

Returns true, if the game event is set. Returns false, if the game event is cleared or never has been defined.

Call this method to get a stored value from the storage manager.

Parameters

valueName: Provide the name of the stored value.


Returns

The method returns the stored value. The method returns null, if there is no value stored for this name.

Call this method to store a game event in the storage manager.

Parameters

eventName: Provide the name of the game event.
setEvent: Provide true to set the game event. Provide false to clear the game event.

Call this method to store a value in the storage manager.

Parameters

valueName: Provide the name of the value, which is to be stored.
value: Provide a string, number, Boolean or null to store as value. If you try to store another type, an error message will be displayed.