GameShield V5 SDK Programming Guide: gs::TGSCore Class Reference

Adds a user defined variable.

Parameters

varName	variable name
varType	TVarType, ref: Variable Type
attr	variable attribute, ref: Variable Attribute
initValStr	string representation of initial variable value

Returns

if the variable already exists, returns the variable object, otherwise returns the the created new variable

Clean up the core.

When the application is terminating, call this api to cleanup the internal data resources.

When game runs in wrapped mode, GS5 kernel will detect game exiting and flush all pending data to local license storage automatically on terminating, so this api is optional and GS5 extension developer do not have to call it manually.

For a simple non-wrapping SDK usage, this api must be called before game terminates to make sure the in-memory pending license changes are saved to local storage.

See Also

gsCleanUp()

Convert event id to human readable string, for debug purpose.

It can be used to display user-friendly debug message to log view.

ref: Event Id

One-time Initialization of gsCore.

One time GS5 kernel initialize, always update local storage as needed. [Read & Write]

It tries to search and load license in the following order:

• Loads from local storage first;
• Loads from embedded license data;
• Loads from input license file;

Parameters

productId	The Product Unique Id. Each product has an unique Id that can be used to identity the application on the remote server.
productLic	The full path to the original license document. This license file is compiled from the GameShield project IDE and defines the initial license status of the product. The file will not be altered and can be deployed in any folder.
licPassword	The string key to decrypt the license document.

Returns

Returns true on success, false on error, uses lastErrorCode()/lastErrorMessage() to get the error information.

Ref:

• Why Core must be initialized before API calling?
• When Core should be initialized in my source code?

Loads from external license file (* Read Only*)

As a read-only viewer, it tries to load from license file and won't update its content.

Parameters

productLic	The full path to the external license file.
productId	The Product Unique Id. Each product has an unique Id that can be used to identity the application on the remote server.
password	The string key to decrypt the license document.

Returns

Returns 0 on success, otherwise non-zero error code, calls lastErrorMessage() to get the error message.

Loads from Local Storage (* Read Only*)

As a read-only viewer, it tries to load from local storage only and won't update local storage.

Parameters

productId	The Product Unique Id. Each product has an unique Id that can be used to identity the application on the remote server.
password	The string key to decrypt the license document.

Returns

Returns 0 on success, otherwise non-zero error code, lastErrorMessage() to get the error message.

Pause the GS5 core time engine.

When GS5 time engine is paused, no event can be fired.

remove user defined variable by its name

Parameters

varName

variable name

Returns

true if success, false if variable not found

Rendering HTML page in process.

Parameters

url	URL to html local file or web site page to render;
title	The caption of form window rendering the HTML page;
width	Pixel width of HTML page;
height	Pixel height of HTML page;

It can be called before init() to render generic HTML pages. However, init() must be called before to render LMApp HTML pages.

The default behavior is:

• Windows Resizable = True;
• ExitAppAfterUI = False;
• CleanUpAfterRender = False;

Rendering HTML with more control (Since SDK 5.0.7)

Parameters

url	URL to html local file or web site page to render;
title	The caption of form window rendering the HTML page;
width	Pixel width of HTML page;
height	Pixel height of HTML page;
resizable,:	The HTML windows is resizable.
exitAppWhenUIClosed,:	Terminate current process when the HTML main windows is manually closed (clicking [x] button on right title for Windows). if false, the UI is just closed.
cleanUpAfterRendering,:	Clean up all of the internal rendering facilities before this API returns. If you cleanup rendering, then the possible conflicts with game are minimized, however, next time the render engine has to be re-created again. WARNING: If set to true, the Qt rendering engine might CRASH for the second time api calling due to Qt internal issue!!! So the best practice is that: Only set cleanUpAfterRendering to true if it is the last time rendering.

If you do not cleanup rendering, the render engine stays active in memory and is quick for next rendering. However, since the Qt/Win stuffs is still alive, it might conflict with game in unexpected way.(Mac: The top main menu bar, about, etc.)

Revokes local license.

This api invalidates current application licenses and returns a string as a receipt.

After this api calling, the application should be terminated because all licenses have been locked down.

Returns

NULL if fails, non-empty string as receipt on success.

The api might fail because:

• Project license setting is not node-locked, hence no reason to lock down local license before transferring license between different machines;
• There is no already unlocked (fully pruchased) license in application, so there is no reason to lock down a demo version;
• Local license storage updating error;

Test if the current process is running inside GS5 Ironwrapper runtime.

It can be called before gsInit().

tick the core time engine from external timer

The external timer frequency is not necessarily 1 HZ. Using an external timer you can control the thread context in which GS events are fired.

Output debug message.

For SDK/Debug version, the message is appended to the current debug log file. For SDK/Release version, the message is displayed in: (1) DebugViewer (Windows via OutputDebugString); (2) Console (Unix via printf)

Turn off internaltimer.

After TGSCore::init() is called, the internal timer is automatically turned on. if you want to use your own timer, you should turn off the internal timer first, then call tickFromExteralTimer() manually from your timer routine.

Turn on internal timer.

After TGSCore::init() is called, the internal timer is automatically turned on.