IC Python API:RLPy RApplication

From Reallusion Wiki!
Jump to: navigation, search
Main article: Modules.
Last modified: 04/14/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
1 # Get api version
2 api_version = RLPy.RApplication.GetApiVersion()
3 print(api_version)
4 if api_version < (2,0,0):
5    print("API 2.0 is still in development.")

GetApiMajorVersion ( self )

Get API major version.

Returns

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

GetApiMinorVersion ( self )

Get API minor version.

Returns

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

GetCustomDataPath ( self )

Get custom data folder path.

Returns

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

GetDefaultProjectPath ( self )

Get default project path.

Returns

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

GetProductMajorVersion ( self )

Get product major version.

Returns

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

GetProductMinorVersion ( self )

Get product minor version.

Returns

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

GetProductName ( self )

Get product name.

Returns

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

GetProductVersion ( self )

Get product version.

Returns

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

GetProgramPath ( self )

Get program path.

Returns

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

GetSharedCustomDataPath ( self )

Get shared custom data path.

Returns

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

GetSharedTemplateDataPath ( self )

Get shared template data path.

Returns

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

GetTemplateDataPath ( self )

Get template data path.

Returns

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