This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.Plugins.TeslaSuitGeneral Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.

TeslaSuitGeneral Class

Enums

CALLBACK_INDEX#

NameDescription
MASTER_MULTIPLIER_UPDATE = 0The callback that is invoked when a value of the master multiplier changes.
NUM_CALLBACKS = 1Callback counter.

Members


void SetErrorsLog ( bool flag ) #

Enables or disables logging of errors.

Arguments

  • bool flag - true — enable, false — disable

bool IsErrorsLog ( ) #

Checks if logging of errors is enabled.

Return value

true — enabled, false — disabled

SuitManager GetSuitManager ( ) #

Returns the SuitManager interface.

Return value

SuitManager interface

string GetFullVersion ( ) #

Returns the TESLASUIT API version.

Return value

TESLASUIT API version

string CodeToString ( uint code ) #

Returns an ASCII string describing result of a function execution based on passed Result Code of the function.

Arguments

Return value

ASCII string describing result of a function execution

ulong[] GetConnectedSuits ( ) #

Returns IDs of connected TESLASUITs.

Return value

IDs of connected TESLASUITs

ulong LoadAsset ( string path, bool isStatic = false, bool isLoop = false, short layer = 0 ) #

Loads and parses a haptic asset in Haptic Player. The loaded asset can be played by given ID.

Arguments

  • string path - Path to the haptic asset
  • bool isStatic - Flag that defines whether the asset should be removed after being played
  • bool isLoop - Flag that defines whether the asset playback is looped
  • short layer - Layer of haptic mapping

Return value

Haptic asset ID that is used for further processing

uint RemoveAsset ( ulong assetId, bool immediately ) #

Removes a haptic asset.

Arguments

  • ulong assetId - ID of a loaded asset
  • bool immediately - if true, the asset is removed immediately; if false, the asset is removed after it has been played

Return value

A code that describes the result of function execution, one of the following TSP_R_CODE values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

ulong CreateMaterial ( ulong playId, ulong effectId ) #

Creates a haptic material from the loaded haptic sample and haptic effect. Haptic materials are used to invoke the haptic response upon the hit events.

Arguments

  • ulong playId - ID of the loaded haptic sample to be used in the haptic material
  • ulong effectId - ID of the loaded haptic effect to be used in the haptic material

Return value

ID of the created haptic material for further processing

uint UpdateMasterMul ( MasterMulConf mul ) #

Sets the new value of the master multiplier for the haptic power that is applied to all connected suits.

Arguments

  • MasterMulConf mul - The new value of the master multiplier for the haptic power. It is applied to all connected suits

Return value

A code that describes the result of function execution, one of the following TSP_R_CODE values: TS_SUCCESS, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

MasterMulConf GetMasterMultiplier ( uint code ) #

Returns the current value of the master multiplier of the haptic power.

Arguments

  • uint code - A code that describes the result of function execution, one of the following TSP_R_CODE values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

Return value

The value of the master multiplier

uint SubMasterMultiplierUpdate ( ) #

Creates the subscription to the master multiplier updates.

Return value

A code that describes the result of function execution, one of the following TSP_R_CODE values: TS_SUCCESS, TS_FAIL_STARTED, TS_FAIL_ARG, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

bool IsServiceRunning ( ) #

Returns teslasuit.service status.

Return value

true, if the service is running, false, if the service is stopped

bool ServiceStart ( ) #

Starts teslasuit.service.

Return value

true, if the service is started, otherwise false

bool ServiceStop ( ) #

Stops teslasuit.service.

Return value

true, if the service is stopped, otherwise false

bool ServiceRestart ( ) #

Restarts teslasuit.service.

Return value

true, if the service is restarted, otherwise false
Last update: 2020-06-01
Build: ()