Difference between revisions of "Game Cloud"
| Line 34: | Line 34: | ||
== Application Features == | == Application Features == | ||
=== Metadata === | === Metadata === | ||
| + | Application Metadata is a simple way for you to set some key / value pairs in the admin that will be available to your script at run-time. These values cannot be changed by your scripts. You can think of these as configuration values. They are configured on your application's <code>Summary</code> tab. | ||
| + | |||
| + | Your scripts must first set their application context, and then can query these values like so: | ||
| + | <syntaxhighlight lang="javascript"> | ||
| + | Cloud.SetApplication("vww.apps.example"); | ||
| + | |||
| + | var message = Cloud.GetMetadata("StartupMessage"); | ||
| + | |||
| + | Debug.Log("Starting up with message: " + message); | ||
| + | Chat.GetLocalChannel().Broadcast(message); | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | The example above shows how the value of the StartupMessage metadata item can be retrieved and used to broadcast a chat message into the instance local chat. For more information see [[Cloud Global]], [[Chat Global]], [[ChatChannelExtended]] and [[Debug Global]] in the [[World Scripting Reference]]. | ||
| + | |||
=== Data Storage === | === Data Storage === | ||
=== Dependencies === | === Dependencies === | ||
Revision as of 12:04, 23 August 2019
The Game Cloud is a Layer Two component that extends your server to add many common massively multiplayer role playing game (MMORPG) features as well as a suite of server world scripting extensions that simplify game programming.
Contents
Game Cloud Scripting
The Game Cloud offers a large extension to the server JavaScript environment. The main API access points are through the two global objects Cloud and Bot. I will provide scripting examples throughout this document.
Game Cloud Applications
The Game Cloud groups configuration and data storage into containers called Applications. An application can be developed, configured, and tested on your development server, and then published to your live server when you're ready. All of the application's associated objects move with the application as a single unit when transferred.
Developing an Application
Game Cloud applications are created and configured mostly through the Admin Web. Expand Game Cloud on the left navigation menu, and select Applications. Create a test application to get started. See Identifiers and Scope below for advice on selecting a good identifier for your application.
Once created, you can begin creating other Game Cloud objects (features) that will become part of your application. The objects you create will then be available for your world scripts to interact with. More complete examples of how this works will be given below.
Identifiers and Scope
The Game Cloud makes heavy use Identifiers which are strings of text that uniquely identify some object within a scope. Your application will have an identifier, as will most of the things you create within your application.
Good identifiers should use namespacing to help ensure they are unique. Identifiers should not contain spaces. I recommend you use a format like this:
company.feature.name
For Example
- vww.quests.firstquest
This helps ensure that things created by different companies or teams don't interfere with each other.
Generally speaking, identifiers are global in scope. This means they should be unique across all applications on your server. This is because an application groups objects for transfer, but does not provide a naming container. This is so that scripts and features from one application can interact with scripts and features from another application.
Data Storage and Scope
The Game Cloud offers several ways for your scripts to store and retrieve data. These are explained in Metadata and Data Storage sections. Data storage is always associated with (scoped to) an application. When a script wants to work with application data, it must first set an application context like so:
Cloud.SetApplication("vww.apps.example");
Generally, application data is considered to be "server local". This means that your application's stored data is not transferred between servers with the application. This is because the data stored by your scripts represents the runtime state of your world. What is transferred is the ``configuration`` of your Game Cloud features and also any Metadata stored with your application.
Application Features
Metadata
Application Metadata is a simple way for you to set some key / value pairs in the admin that will be available to your script at run-time. These values cannot be changed by your scripts. You can think of these as configuration values. They are configured on your application's Summary tab.
Your scripts must first set their application context, and then can query these values like so:
Cloud.SetApplication("vww.apps.example"); var message = Cloud.GetMetadata("StartupMessage"); Debug.Log("Starting up with message: " + message); Chat.GetLocalChannel().Broadcast(message);
The example above shows how the value of the StartupMessage metadata item can be retrieved and used to broadcast a chat message into the instance local chat. For more information see Cloud Global, Chat Global, ChatChannelExtended and Debug Global in the World Scripting Reference.
