stingray.Application namespace reference

Description

Interface to access global application functionality.

Note that since the application is a singleton (there is only one application), you don't need to pass any Application object to any of the Application functions. All the functions operate on the application singleton.

Related sample code

Appkit: /appkit_flow_callbacks.lua Appkit: /app.lua Appkit: /debug_menu.lua Appkit: /debug_scrollbox.lua Appkit: /input_mapper.lua Appkit: /level_wrapper.lua Appkit: /loading_screen.lua Appkit: /simple_project.lua Appkit: /util.lua Appkit: /world_wrapper.lua Character template: /input_mapper.lua Minimal template: /boot.lua

Other related reference items

Core

Related help topics

	Release Notes > Stingray 1.7 Release Notes
	Release Notes > Stingray 1.6 Release Notes
	Release Notes > Stingray 1.5 Release Notes
	Creating Gameplay > Scripting with Lua > Starting Lua from a template: Using the Appkit > Managing worlds, levels and cameras through the Appkit
	Creating Gameplay > Scripting with Lua > Starting Lua from scratch: using a custom boot script
	Creating Gameplay > Scripting with Lua > Starting Lua from scratch: using a custom boot script > Example Boot Script
	Creating Gameplay > Scripting with Lua > Starting Lua from scratch: using a custom boot script > Loading the current level for testing
	Creating Gameplay > Scripting with Lua > Using the Lua API > Object lifetimes and userdata binding
	Creating Gameplay > Scripting with Lua > Loading and running your own script files
	Creating Gameplay > Scripting with Lua > Create custom Flow nodes in Lua
	Creating Gameplay > Physics > Basic physics concepts
	Managing Content and Resources > Loading and unloading content at runtime > Loading and unloading packages
	Managing Content and Resources > Loading and unloading content at runtime > Loading resources automatically
	Managing Content and Resources > Loading and unloading content at runtime > Example: Loading and unloading one resource package per level
	Managing Content and Resources > Localizing your game > Localizing resources
	Playtesting Your Game > Ways to get runtime feedback
	Playtesting Your Game > Connect to a remote device > Using the Connections panel
	Playtesting Your Game > Optimize memory usage
	After You Release > Downloadable content (DLC) and other extras
	After You Release > Downloadable content (DLC) and other extras > Creating a database of DLC content
	Reference > Stingray engine settings.ini file reference
	Reference > Stingray engine command-line reference

Functions

argv ( ) : string* Returns the command-line arguments that were supplied to the engine when it was executed, if any.

Parameters

This function does not accept any parameters.

Returns

string*

Each of the command line arguments is returned as a separate string. The * notation indicates that there may be zero or more instances of the specified type.

back_buffer_size ( window ) : number, number Returns the back buffer resolution.

Parameters

window :

stingray.Window?

Optional; used only when rendering to multiple swap chains on PC. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

number	The back buffer resolution width, in pixels.
number	The back buffer resolution height, in pixels.

Do not call the deprecated version of this named "resolution".

Related sample code

Oculus VR template: /s3d_ui.lua Picking a unit with the mouse

Other related reference items

stingray.Gui.resolution() stingray.World.create_screen_gui()

begin_scoped_autoload ( ) : integer When autoloading is enabled and this function is called, then all the resources that are autoloaded will be unloaded when end_scoped_autoloaded is called.

Parameters

This function does not accept any parameters.

Returns

integer

The offset from which to unload the autoloaded resources.

build ( ) : string Identifies the build mode of the engine.

Parameters

This function does not accept any parameters.

Returns

string

One of the following strings: debug, dev or release.

build_identifier ( ) : string Identifies the build version number of the engine.

Parameters

This function does not accept any parameters.

Returns

string

A string that identifies the build version number of the engine.

For example: 2437 branch:release2.

If you rebuild the engine on your own, you can set this build identifier in a post-processing step after you have built the engine executable. The built executable will contain the string a4e915264ceaa4424b3ed6d3d2fe5e1a, followed by 128 zero characters. You can replace the zero characters with whatever string you want this build_identifier() function to return.

can_get ( type, name ) : boolean Indicates whether or not the specified resource is available.

Parameters

type :	string	The type of the resource to find.
name :	string	The name of the resource to find.

Returns

boolean

true if the specified resource is available, or false otherwise.

Related sample code

Appkit: /app.lua Appkit: /level_wrapper.lua

clear_resource_override ( type, name ) Clears a resource override set by set_resource_override().

Parameters

type :	string	The type of the resource being overridden.
name :	string	The name of the resource being overridden.

Returns

This function does not return any values.

Other related reference items

stingray.Application.set_resource_override()

clear_resource_override_flag ( name ) Clears a resource override flag set by set_resource_override_flag()

Parameters

name :

string

The flag that should be removed.

Returns

This function does not return any values.

Other related reference items

stingray.Application.set_resource_override_flag()

console_command ( command, parameters ) Simulates sending a command from the console directly to the game.

Parameters

command :	string	The command to send to the console.
parameters :	string*	Zero or more additional command-line parameters to pass along with the command. The * notation indicates that there may be zero or more instances of the specified type.

Returns

This function does not return any values.

console_port ( ) : integer Indicates the number of the port that the console is listening on.

Parameters

This function does not accept any parameters.

Returns

integer

The port number of the console.

console_send ( command, data, length ) Sends the specified command to the Stingray console, the same as if it had been sent from an external editor.

Parameters

command :	console_commands	The information that you want to send to the console, expressed in a string-keyed table.
data :	string?	Optional pointer to binary data to send. If this is supplied then length must also be given. The ? notation indicates that this type is optional: there may be zero or one instances of it.
length :	number?	Length of binary data, if any. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

You can use this function to print messages, warnings and errors to the console, or send arbitrary messages to other clients of the engine's console server.

Other related reference items

console_commands

create_viewport ( world, viewport_template ) : stingray.Viewport Creates a viewport that will be used when rendering the specified world using the named viewport template, which must be set up in the render config file.

Parameters

world :	stingray.World	The world that will be rendered in the new viewport.
viewport_template :	string	The name of the viewport template that determines the characteristics of the viewport.

Returns

stingray.Viewport

The newly created Viewport.

When you are finished with this viewport, you should destroy it by calling destroy_viewport().

Other related reference items

stingray.Application.destroy_viewport()

destroy_viewport ( world, viewport ) Destroys a viewport that was previously created by a call to create_viewport().

Parameters

world :	stingray.World	The world being rendered in the viewport you want to destroy.
viewport :	stingray.Viewport	The viewport you want to destroy.

Returns

This function does not return any values.

Other related reference items

stingray.Application.create_viewport()

end_scoped_autoload ( offset ) Will unload all resources that were autoloaded between the calls of begin_scoped_autoload and end_scoped_autoload.

Parameters

offset :

integer

The offset from which to unload the autoloaded resources.

Returns

This function does not return any values.

flow_callback_context_entity ( ) : stingray.Entity Returns the Entity which owns the currently executing flow node, or nil if this node is not owned by an Entity.

Parameters

This function does not accept any parameters.

Returns

stingray.Entity

The Entity which owns the executing flow node.

flow_callback_context_level ( ) : stingray.Level Returns the Level which owns the currently executing flow node, or nil if this node is not owned by a Level.

Parameters

This function does not accept any parameters.

Returns

stingray.Level

The Level which owns the executing flow node.

flow_callback_context_unit ( ) : stingray.Unit Returns the Unit which owns the currently executing flow node, or nil if this node is not owned by a Unit.

Parameters

This function does not accept any parameters.

Returns

stingray.Unit

The Unit which owns the executing flow node.

flow_callback_context_world ( ) : stingray.World Returns the World which owns the currently executing flow node, or nil if this node is not owned by a World.

Parameters

This function does not accept any parameters.

Returns

stingray.World

The World which owns the executing flow node.

get_data ( indices ) : any Retrieves the data set at the specified indices within the global script data object.

Parameters

indices :

any(integer, string)+

One or more indices for the data, which may be integers or strings. The + notation indicates that there may be one or more instances of the specified type. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.

Returns

any	The data value stored at the specified sequence of indices, if any.

Other related reference items

stingray.Application.set_data()

has_data ( indices ) Indicates whether or not any data has been saved at the specified indices in the global script data object.

Parameters

indices :

any(integer, string)+

One or more indices for the data, which may be integers or strings. The + notation indicates that there may be one or more instances of the specified type. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.

Returns

This function does not return any values.

main_world ( ) : stingray.World Debug helper function that returns the "most important" game world.

Parameters

This function does not accept any parameters.

Returns

stingray.World

The World that is determined to be the most important.

This is usually the world where stuff is happening, and in which you want to test particle effects, sounds, etc.

The "most important" world is defined as the world that was rendered last frame that contains the most units.

Related sample code

Creating meshes procedurally

make_hash ( values ) : string Creates a combined hash out of the arguments.

Parameters

values :

any+

The values to use when creating the hash. This list must contain at least one value. Accepts numbers, nil, strings, and hex numbers expressed as strings. The + notation indicates that there may be one or more instances of the specified type.

Returns

string

A 64-bit hexadecimal hash.

new_world ( flags ) : stingray.World Creates and returns a new game World.

Parameters

flags :

integer*

Any number of New World Flags that set up properties for the new world. The * notation indicates that there may be zero or more instances of the specified type.

Returns

stingray.World

The newly created World.

You can have as many game worlds as you like. Multiple game worlds may be useful for things like loading screens or inventory rooms.

NOTE: Always remember to free every world you create by calling release_world() when you are done with it.

Other related reference items

	stingray.Application.APEX_LOD_RESOURCE_BUDGET
	New World Flags

open_url_in_browser ( url ) Opens the specified URL in the default browser.

Parameters

url :

string

The URL to open.

Returns

This function does not return any values.

platform ( ) : string Identifies the platform the application is currently running on.

Parameters

This function does not accept any parameters.

Returns

string

One of the Application object's platform constants, such as WIN32 or ANDROID.

Related sample code

Basic template: /main_menu.lua Character template: /main_menu.lua Vehicle template: /main_menu.lua Oculus VR template: /main_menu.lua

quit ( exit_code ) Quits the application.

Parameters

exit_code :

integer?

If supplied, specifies the exit code of the application. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

This function does not exist on the PlayStation 3, since it is forbidden to exit without a termination request from the SDK.

Related sample code

Basic template: /main_menu.lua Character template: /main_menu.lua Vehicle template: /main_menu.lua Oculus VR template: /main_menu.lua Oculus VR template: /player.lua

release_resource_package ( package ) Frees a resource package that was previously created by a call to resource_package().

Parameters

package :

stingray.ResourcePackage

The package to be destroyed.

Returns

This function does not return any values.

Other related reference items

stingray.Application.resource_package() stingray.Application.resource_package_from_url()

release_world ( world ) Destroys the specified World.

Parameters

world :

stingray.World

The World you want to destroy.

Returns

This function does not return any values.

You should call this when you are completely done with a particular world.

Other related reference items

stingray.Application.new_world()

render_caps ( caps ) : boolean+ Returns the status of the specified render caps.

Parameters

caps :

string+

One or more render caps whose status will be retrieved. The + notation indicates that there may be one or more instances of the specified type.

Returns

boolean+

Returns a separate boolean value for each argument. The + notation indicates that there may be one or more instances of the specified type.

render_world ( world, camera, viewport, shading_environment, window ) Renders the specified world, with the specified shading environment, using the specified camera, in the specified viewport.

Parameters

world :	stingray.World	The World that you want to render.
camera :	stingray.Camera	The Camera that defines the point of view for the rendering.
viewport :	stingray.Viewport	The Viewport that will contain the rendering.
shading_environment :	stingray.ShadingEnvironment	The ShadingEnvironment that determines the characteristics of the rendering. NOTE: If a shading environment entity exists in any of the levels loaded into the world, this parameter is not used. The settings are read from the entity instead.
window :	stingray.Window?	Optional; used only when rendering to multiple swap chains on PC. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

Other related reference items

	stingray.ShadingEnvironment
	stingray.World.set_frustum_inspector_camera()

resource_package ( name ) : stingray.ResourcePackage Creates a resource package from the .package file with the specified name.

Parameters

name :

string

The file name of the .package file to use when creating the new resource package.

Returns

stingray.ResourcePackage

The new resource package.

NOTE: Always remember to free every resource package you create by calling release_resource_package() when you are done with it.

Other related reference items

stingray.Application.release_resource_package()

resource_package_from_url ( name ) : stingray.ResourcePackage Creates a resource package from a bundle located on a web server.

Parameters

name :

string

The URL of the bundle file to use when creating the new resource package.

Returns

stingray.ResourcePackage

The new resource package.

NOTE: Always remember to free every resource package you create by calling release_resource_package() when you are done with it.

restart_file_log ( local_filename, remote_filename ) Closes the current file log, copies the remote log, and then restarts logging.

Parameters

local_filename :	string?	Optional. If specified, the new log will use this path. If not specified, the last log will be overwritten. The ? notation indicates that this type is optional: there may be zero or one instances of it.
remote_filename :	string?	Optional. If specified, the new remote log will use this path. If not specified, the last remote log will be overwritten. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

The paths and file names that you pass to this function can contain the following variables, which will be expanded automatically:

• %%APPDATA%%: The platform-specific folder for storing user data. For example, on Windows, this is C:\Users\<username>\AppData, and on Mac OS this is ~/Library/Application Support.
• %%HOSTNAME%%: The host name of the computer.
• %%DATE%%: The current date, in the form YYYY-MM-DD.
• %%TIME%%: The current time, in the form HH.MM.SS.
• %%RANDOM%%: Eight random letters.
• %%OBBPATH%%: On Android, the path to the OBB file directory.

save_user_settings ( ) Saves the contents of the current user settings data object to a file on disk.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

The path and file name are determined by the key win32.user_settings or macosx.user_settings in the settings.ini file. The string %%APPDATA%% in the file name will be expanded to the user's AppData or Application Support folder. For example:

win32 = {
user_settings = "%%APPDATA%%\\CompanyName\\GameTitle\\user_settings.config"
}

macosx = {
user_settings = "%%APPDATA%%/CompanyName/GameTitle/user_settings.config"
}

Other related reference items

stingray.Application.set_user_setting()

settings ( ) : table Returns an object that contains the script settings specified in the settings.ini file: i.e. whatever is found in the settings.ini file under the script_data setting.

Parameters

This function does not accept any parameters.

Returns

table

A table that contains data read from the script_data setting in the settings.ini file.

Related sample code

Appkit: /main.lua

set_autoload_enabled ( isEnabled ) Determines whether or not the auto-loading mechanism is enabled.

Parameters

isEnabled :

boolean

true to enable auto-loading, or false otherwise.

Returns

This function does not return any values.

If enabled, the package system will be disabled, and all resources will be automatically loaded as they are accessed.

Other related reference items

stingray.Application.autoload_resource_package()

set_data ( indices, indices, indices, value ) set_data ( indices, indices, value ) set_data ( indices, value ) Stores the specified value in a global script data object, at a location determined by the specified indices.

Parameters

indices :	any(integer, string)	One or more indices for the data, which may be integers or strings. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.
value :	any	The value to store.

Returns

This function does not return any values.

You can retrieve the data later by passing the same indices in a call to get_data().

set_resource_override ( type, name, override ) Specifies that the resource override should override the resource name.

Parameters

type :	string	The type of the resource to override.
name :	string	The name of the resource to override.
override :	string	The resource it should be replaced with.

Returns

This function does not return any values.

I.e. whenever any engine system requests the resource name, the resource override will be returned instead. To remove an override, use clear_resource_override().

Other related reference items

stingray.Application.clear_resource_override()

set_resource_override_flag ( flag, priority ) Sets the value of a resource override flag.

Parameters

flag :	string	The flag whose priority we should set.
priority :	integer	The priority of the flag.

Returns

This function does not return any values.

These values are used when resource overrides have been compiled with runtime flags. When a resource is requested, the override that corresponds to the flag with the highest priority will be used. The base resource (with no flags) is considered to have a priority of 0. To remove an override flag, use clear_resource_override_flag()

Other related reference items

stingray.Application.clear_resource_override_flag()

set_tablet_pen_service_properties ( properties ) Sets windows tablet pen and service properties

Parameters

properties :

number

Can be any combination of the defined Pen Service Properties values. (e.g., stingray.Input.TabletPenServiceProperty.DISABLE_PRESSANDHOLD + Input.TabletPenServiceProperty.DISABLE_SMOOTHSCROLLING).

Returns

This function does not return any values.

set_time_step_policy ( params ) Controls how the application's time step is advanced.

Parameters

params :

any+

A list of configuration parameters and their corresponding values. The + notation indicates that there may be one or more instances of the specified type.

Returns

This function does not return any values.

This function accepts the following parameters:

• "variable": Configures the engine to use variable time stepping. This is the default time step setting.
• "fixed", fps: Configures the engine to run with fixed time steps at the specified frame rate. This means that the time steps taken will always be a multiple of 1/fps. If the engine runs faster than the specified frame rate, it will compensate by taking zero-length time steps.
• "throttle", fps: Throttles the engine to the specified frame rate. The engine will be slowed down to run at the requested rate. This can be used to debug problems that only appear when the frame rate is low.
• "no_throttle": Disables throttling. This is the default setting.
• "variable": Disables throttling. This is the default.
• "smoothing", frames, outliers, lerp: Configures the engine to use time step smoothing. When variable time stepping is used, smoothing the time steps over a number of frames can make the game feel less jerky. The frames value specifies the number of frames that should be averaged. The outliers value specifies how many extreme values to remove. For example, with a value of 2, the two highest and the two lowest values are removed before the average is computed. The lerp value specifies how fast the value is allowed to change from the computed average. A low value means more smoothing, a higher value less smoothing. The defaults are 11, 2, 0.1.
• "no_smoothing": Disables time step smoothing.
• "debt_payback", frames: If set to a non-zero value, the timer will try to keep track of its time debt -- i.e. how much the game time has drifted from an external world clock (because of smoothing, etc.) -- and will try to pay that debt back over the specified number of frames by adding extra time to them. This can be useful if you need your game to stay in sync with an external clock (for example, for networking), because otherwise your game can "lose" time. The default is 0.
• "external_step_range", min, max: Specifies that the external world time should be clamped to the specified range before it is put in to the system. This is useful for preventing the system from taking really large steps when you break in the debugger. The default values are 0, 0.2.
• "external_multiplier", multiplier: Sets a multiplier that can be used to accelerate or slow down the time for debugging purposes. The default value is 1.
• "system_step_range", min, max: Specifies the minimum and maximum steps that the game is allowed to take. The default values are 0, 0.2.
• "clear_history": Clears the history of accumulated time debt, smoothing history, etc.
• "jump", time: Jumps the timer forward in the next frame by the specified number of seconds. Useful for previewing lengthy animations.

sysinfo ( ) : string Indicates the hardware that the game runs on.

Parameters

This function does not accept any parameters.

Returns

string

A string that describes the hardware the game runs on.

This is typically used in error messages in order to append some extra detail about the hardware on which the error occurred, in case that information would be helpful in diagnosing and correcting the error.

time_since_launch ( ) : number Returns the elapsed time, in seconds, since the application was launched.

Parameters

This function does not accept any parameters.

Returns

number

The elapsed time, in seconds.

user_settings_load_error ( ) : boolean Indicates whether or not an error occurred when loading the user settings data file.

Parameters

This function does not accept any parameters.

Returns

boolean

true if the user settings file exists but could not be loaded, or false otherwise.

If this function returns true, the file may be corrupt. In this case, default strings will be used. Note that a missing data file is not considered a load error.

worlds ( ) : stingray.World[] Returns all the game worlds you have created.

Parameters

This function does not accept any parameters.

Returns

stingray.World[]

A table of World objects. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.

Development only

The elements in this group are only available in development builds.

Do not use them in your final builds.

autoload_resource_package ( name ) When autoload is enabled, automatically loads all the resources from the specified resource package.

Parameters

name :

string

The package to load.

Returns

This function does not return any values.

See also set_autoload_enabled().

guid ( ) : string Returns a globally unique identifier, which can be useful for identifying particular objects.

Parameters

This function does not accept any parameters.

Returns

string

A new globally unique identifier.

Only available on Windows platforms and in development builds or on Xbox One.

sleep ( milliseconds ) Sleeps for the specified amount of time.

Parameters

milliseconds :

number

The time to sleep, in milliseconds.

Returns

This function does not return any values.

toggle_dev_only_warnings ( enabled ) Enables warnings to be printed out every time a function that is only available in development builds is called from Lua.

Parameters

enabled :

boolean

True if development only warnings should be enabled

Returns

This function does not return any values.

New World Flags

The constants listed in this group can be passed as arguments in calls to Application.new_world().

APEX_LOD_RESOURCE_BUDGET : integer Sets the apex_lod_resource_budget to a specified value.

If you pass this flag to Application.new_world(), you must also pass an additional argument that indicates the desired value for the resource budget.

DISABLE_APEX_CLOTH : integer Disables Apex cloth simulation in a world.

DISABLE_PHYSICS : integer Disables physics in a world.

DISABLE_RENDERING : integer Disables rendering in a world.

DISABLE_SOUND : integer Disables sound playback in a world.

ENABLE_REPLAY : integer Enables Replay for a world.

Only available in development builds.

Other related reference items

stingray.Replay

Platform IDs

ANDROID = "android" : string The string used internally to represent Android platforms.

Other related reference items

stingray.Application.platform()

IOS = "ios" : string The string used internally to represent iOS platforms.

LINUX = "linux" : string The string used internally to represent the Linux platform.

MACOSX = "macosx" : string The string used internally to represent Mac OS platforms.

PS4 = "ps4" : string The string used internally to represent the PlayStation 4 platform.

Related sample code

Basic template: /main_menu.lua Character template: /main_menu.lua Vehicle template: /main_menu.lua Oculus VR template: /main_menu.lua

UWP = "uwp" : string The string used internally to represent UWP platforms.

WEB = "web" : string The string used internally to represent the Web platform.

WIN32 = "win32" : string The string used internally to represent Windows platforms.

Other related reference items

stingray.Application.platform()

XB1 = "xb1" : string The string used internally to represent the Xbox One platform.

Related sample code

Basic template: /main_menu.lua Character template: /main_menu.lua Vehicle template: /main_menu.lua Oculus VR template: /main_menu.lua

Windows and Mac OS X

The functions in this group are only available on Windows and Mac OS X platforms.

apply_user_settings ( ) Reloads the render config file, and reboots the renderer using the new settings read from the file.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

enum_display_modes ( ) : table Returns detailed information about all available display modes on all screens.

Parameters

This function does not accept any parameters.

Returns

table

A table of Vector3 objects, each of which describes a single display mode. Each Vector3 stores the information as follows: (width, height, screen_index).

NOTE: This function is considered deprecated, and exists only to preserve backward compatibility. For all new development, use the DisplayAdapter interface instead.

Other related reference items

stingray.DisplayAdapter

process_id ( ) : integer Returns the process ID assigned to the application by the operating system.

Parameters

This function does not accept any parameters.

Returns

integer

The process ID.

scan_for_windows_ps4_controllers ( ) Detects and setups all PS4 controllers connected to the PC.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

New PS4 controllers connected to the PC are not automatically detected after startup. Use this function to detect and setup the connected controllers and remove references to disconnected controllers.

When calling this function the order of the controllers can change, so the different PS4Pad1 interfaces can represent different physical devices.

After calling this function the first found PS4 controller will be available as PS4Pad1, the second as PS4Pad2, etc. If you call this function multiple times, there is no guarantee that the order of controllers is preserved. I.e., a controller previously detected as PS4Pad3 may now be PS4Pad1.

This function only exists on Windows.

Other related reference items

stingray.PS4Pad1 stingray.PS4Pad2 stingray.PS4Pad3 stingray.PS4Pad4

set_max_frame_stacking ( frames ) Sets the maximum number of frames that are permitted to be stacked in the driver and the GPU.

Parameters

frames :

number

The maximum number of frames, or -1 to disable frame stacking.

Returns

This function does not return any values.

This is implemented by issuing a D3D11_QUERY_EVENT once per frame in a round-robin fashion, and every frame waits for the oldest event in the queue.

This feature is intended to reduce "mouse lag" on slow machines. Available for Windows platforms only.

NOTE: It is highly recommended that you avoid using this function unless absolutely necessary. It should only be considered as a last resort.

set_user_setting ( indices, indices, indices, value ) set_user_setting ( indices, indices, value ) set_user_setting ( indices, value ) Stores the specified value in the user settings data object, at a location determined by the specified indices.

Parameters

indices :	any(integer, string)	One or more indices for the data, which may be integers or strings. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.
value :	any	The value to store.

Returns

This function does not return any values.

You can retrieve the data later by passing the same indices in a call to user_setting(). See also save_user_settings() to persist the change to disk.

user_setting ( indices ) Retrieves the data set at the specified indices within the user settings data object.

Parameters

indices :

any(integer, string)+

One or more indices for the data, which may be integers or strings. The + notation indicates that there may be one or more instances of the specified type. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.

Returns

This function does not return any values.

Other related reference items

stingray.Application.set_user_setting()