IC Python API:RLPy RApplication

From Reallusion Wiki!
Revision as of 22:37, 9 April 2020 by Eric (Talk | contribs) (Returns)

Jump to: navigation, search

Main article: Modules. Last modified: 04/9/2020

Description

This class mainly provides information about the application, such as application version number, API version number, or related application paths.

Member Functions

GetApiVersion ( self )

Get API version.

Returns

API version (major, minor, sub-version) - int tuple
# Get api version
api_version = RLPy.RApplication.GetApiVersion()
print(api_version)
if api_version < (2,0,0):
   print("API 2.0 is still in development.")

GetApiMajorVersion ( self )

Get API major version.

Returns

API major version - int
# Get api major version
api_major_version = RLPy.RApplication.GetApiMajorVersion()
print(api_major_version)

GetApiMinorVersion ( self )

Get API minor version.

Returns

API minor version - int
# Get api minor version
api_minor_version = RLPy.RApplication.GetApiMinorVersion()
print(api_minor_version)

GetCustomDataPath ( self )

Get custom data folder path.

Returns

Custom data path - string
# Get custom data path
custom_data_path = RLPy.RApplication.GetCustomDataPath()
print(custom_data_path)

GetDefaultProjectPath ( self )

Get default project path.

Returns

Default project path - string
# Get default project path
default_project_path = RLPy.RApplication.GetDefaultProjectPath()
print(default_project_path)

GetProductMajorVersion ( self )

Get product major version.

Returns

Product major version - int
# Get product major version
product_major_version = RLPy.RApplication.GetProductMajorVersion()
print(product_major_version)

GetProductMinorVersion ( self )

Get product minor version.

Returns

Product minor version - int
# Get product minor version
product_minor_version = RLPy.RApplication.GetProductMinorVersion()
print(product_minor_version)

GetProductName ( self )

Get product name.

Returns

Product name - string
# Get product name
product_name = RLPy.RApplication.GetProductName()
print(product_name)

GetProductVersion ( self )

Get product version.

Returns

Product version (major, minor, subversion) - int tuple
# Get product version
product_version = RLPy.RApplication.GetProductVersion()
print(product_version)
if product_version < (8,0,0):
   print("iClone 8 is still in development.")

GetProgramPath ( self )

Get program path.

Returns

Program path - string
# Get program path
program_path = RLPy.RApplication.GetProgramPath()
print(program_path)

GetSharedCustomDataPath ( self )

Get shared custom data path.

Returns

Shared custom data path - string
# Get shared custom data path
shared_custom_data_path = RLPy.RApplication.GetSharedCustomDataPath()
print(shared_custom_data_path)

GetSharedTemplateDataPath ( self )

Get shared template data path.

Returns

Shared template data path - string
# Get shared template data path
shared_template_data_path = RLPy.RApplication.GetSharedTemplateDataPath()
print(shared_template_data_path)

GetTemplateDataPath ( self )

Get template data path.

Returns

Template data path - string
# Get template data path
template_data_path = RLPy.RApplication.GetTemplateDataPath()
print(template_data_path)