Difference between revisions of "IC8 Python API:RLPy RApplication"
From Reallusion Wiki!
Chuck (RL) (Talk | contribs) (Created page with "{{TOC}} {{Parent|IC_8_Python_API:Modules|iC8 Modules}} {{last_modified}} ==Detailed Description== This class provides application-related API. ==Member Functions== ===RLPy....") |
Chuck (RL) (Talk | contribs) m |
||
| Line 3: | Line 3: | ||
{{last_modified}} | {{last_modified}} | ||
| − | == | + | ==Description== |
This class provides application-related API. | This class provides application-related API. | ||
| − | == | + | ==Functions== |
===RLPy.RApplication.GetApiMajorVersion()=== | ===RLPy.RApplication.GetApiMajorVersion()=== | ||
Get API major version. | Get API major version. | ||
| + | |||
| + | ====Returns==== | ||
| + | API major version - int | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 15: | Line 18: | ||
print(api_major_version) | print(api_major_version) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetApiMinorVersion()=== | ===RLPy.RApplication.GetApiMinorVersion()=== | ||
Get API minor version. | Get API minor version. | ||
| + | |||
| + | ====Returns==== | ||
| + | API minor version - int | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 26: | Line 29: | ||
print(api_minor_version) | print(api_minor_version) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetApiVersion()=== | ===RLPy.RApplication.GetApiVersion()=== | ||
Get the API version. | Get the API version. | ||
| + | |||
| + | ====Returns==== | ||
| + | API version(major, minor, subversion) - int | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 39: | Line 42: | ||
print("API 2.0 is still in development.") | print("API 2.0 is still in development.") | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetContentFilesInFolder(strFolder)=== | ===RLPy.RApplication.GetContentFilesInFolder(strFolder)=== | ||
Get absolute files in the template content folder. | Get absolute files in the template content folder. | ||
| + | |||
| + | ====Returns==== | ||
| + | Absolute files in template content folder - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
# No example | # No example | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetContentFoldersInFolder(strFolder)=== | ===RLPy.RApplication.GetContentFoldersInFolder(strFolder)=== | ||
Get relative folders in the template content folder. | Get relative folders in the template content folder. | ||
| + | |||
| + | ====Returns==== | ||
| + | Relative folders in template content folder - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
# No example | # No example | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetCustomContentFolder(eFolderType)=== | ===RLPy.RApplication.GetCustomContentFolder(eFolderType)=== | ||
Get custom content folder path. | Get custom content folder path. | ||
| + | |||
| + | ====Returns==== | ||
| + | Custom content folder path - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
# No example | # No example | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetCustomDataPath()=== | ===RLPy.RApplication.GetCustomDataPath()=== | ||
Get the custom data path. | Get the custom data path. | ||
| + | |||
| + | ====Returns==== | ||
| + | Custom data path - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 80: | Line 83: | ||
print(custom_data_path) | print(custom_data_path) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetDefaultContentFolder(eFolderType)=== | ===RLPy.RApplication.GetDefaultContentFolder(eFolderType)=== | ||
Get the default template content folder relative path. | Get the default template content folder relative path. | ||
| + | |||
| + | ====Returns==== | ||
| + | Default template content folder relative path - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
# No example | # No example | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetDefaultProjectPath()=== | ===RLPy.RApplication.GetDefaultProjectPath()=== | ||
Get the default project path. | Get the default project path. | ||
| + | |||
| + | ====Returns==== | ||
| + | Default project path - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 101: | Line 104: | ||
print(default_project_path) | print(default_project_path) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetProductMajorVersion()=== | ===RLPy.RApplication.GetProductMajorVersion()=== | ||
Get the product's major version. | Get the product's major version. | ||
| + | |||
| + | ====Returns==== | ||
| + | Product major version - int | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 112: | Line 115: | ||
print(product_major_version) | print(product_major_version) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetProductMinorVersion()=== | ===RLPy.RApplication.GetProductMinorVersion()=== | ||
Get the product's minor version. | Get the product's minor version. | ||
| + | |||
| + | ====Returns==== | ||
| + | Product minor version - int | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 123: | Line 126: | ||
print(product_minor_version) | print(product_minor_version) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetProductName()=== | ===RLPy.RApplication.GetProductName()=== | ||
Get product name. | Get product name. | ||
| + | |||
| + | ====Returns==== | ||
| + | Product name - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 134: | Line 137: | ||
print(product_name) | print(product_name) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetProductVersion()=== | ===RLPy.RApplication.GetProductVersion()=== | ||
Get the product version. | Get the product version. | ||
| + | |||
| + | ====Returns==== | ||
| + | Product version(major, minor, subversion) - int | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 147: | Line 150: | ||
print("iClone 8 is still in development.") | print("iClone 8 is still in development.") | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetProgramPath()=== | ===RLPy.RApplication.GetProgramPath()=== | ||
Get program path. | Get program path. | ||
| + | |||
| + | ====Returns==== | ||
| + | Program path - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 158: | Line 161: | ||
print(program_path) | print(program_path) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
===RLPy.RApplication.GetTemplateDataPath()=== | ===RLPy.RApplication.GetTemplateDataPath()=== | ||
Get template data path. | Get template data path. | ||
| + | |||
| + | ====Returns==== | ||
| + | Template data path - string | ||
<syntaxhighlight lang="python" line='line'> | <syntaxhighlight lang="python" line='line'> | ||
| Line 169: | Line 172: | ||
print(template_data_path) | print(template_data_path) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
Revision as of 00:28, 27 December 2022
Contents
- 1 Description
- 2 Functions
- 2.1 RLPy.RApplication.GetApiMajorVersion()
- 2.2 RLPy.RApplication.GetApiMinorVersion()
- 2.3 RLPy.RApplication.GetApiVersion()
- 2.4 RLPy.RApplication.GetContentFilesInFolder(strFolder)
- 2.5 RLPy.RApplication.GetContentFoldersInFolder(strFolder)
- 2.6 RLPy.RApplication.GetCustomContentFolder(eFolderType)
- 2.7 RLPy.RApplication.GetCustomDataPath()
- 2.8 RLPy.RApplication.GetDefaultContentFolder(eFolderType)
- 2.9 RLPy.RApplication.GetDefaultProjectPath()
- 2.10 RLPy.RApplication.GetProductMajorVersion()
- 2.11 RLPy.RApplication.GetProductMinorVersion()
- 2.12 RLPy.RApplication.GetProductName()
- 2.13 RLPy.RApplication.GetProductVersion()
- 2.14 RLPy.RApplication.GetProgramPath()
- 2.15 RLPy.RApplication.GetTemplateDataPath()
- Main article: iC8 Modules.
- Last modified: 12/27/2022
Description
This class provides application-related API.
Functions
RLPy.RApplication.GetApiMajorVersion()
Get API major version.
Returns
API major version - int
1 api_major_version = RLPy.RApplication.GetApiMajorVersion()
2 print(api_major_version)
RLPy.RApplication.GetApiMinorVersion()
Get API minor version.
Returns
API minor version - int
1 api_minor_version = RLPy.RApplication.GetApiMinorVersion()
2 print(api_minor_version)
RLPy.RApplication.GetApiVersion()
Get the API version.
Returns
API version(major, minor, subversion) - int
1 api_version = RLPy.RApplication.GetApiVersion()
2 print(api_version)
3 if api_version < (2,0,0):
4 print("API 2.0 is still in development.")
RLPy.RApplication.GetContentFilesInFolder(strFolder)
Get absolute files in the template content folder.
Returns
Absolute files in template content folder - string
1 # No example
RLPy.RApplication.GetContentFoldersInFolder(strFolder)
Get relative folders in the template content folder.
Returns
Relative folders in template content folder - string
1 # No example
RLPy.RApplication.GetCustomContentFolder(eFolderType)
Get custom content folder path.
Returns
Custom content folder path - string
1 # No example
RLPy.RApplication.GetCustomDataPath()
Get the custom data path.
Returns
Custom data path - string
1 custom_data_path = RLPy.RApplication.GetCustomDataPath()
2 print(custom_data_path)
RLPy.RApplication.GetDefaultContentFolder(eFolderType)
Get the default template content folder relative path.
Returns
Default template content folder relative path - string
1 # No example
RLPy.RApplication.GetDefaultProjectPath()
Get the default project path.
Returns
Default project path - string
1 default_project_path = RLPy.RApplication.GetDefaultProjectPath()
2 print(default_project_path)
RLPy.RApplication.GetProductMajorVersion()
Get the product's major version.
Returns
Product major version - int
1 product_major_version = RLPy.RApplication.GetProductMajorVersion()
2 print(product_major_version)
RLPy.RApplication.GetProductMinorVersion()
Get the product's minor version.
Returns
Product minor version - int
1 product_minor_version = RLPy.RApplication.GetProductMinorVersion()
2 print(product_minor_version)
RLPy.RApplication.GetProductName()
Get product name.
Returns
Product name - string
1 product_name = RLPy.RApplication.GetProductName()
2 print(product_name)
RLPy.RApplication.GetProductVersion()
Get the product version.
Returns
Product version(major, minor, subversion) - int
1 product_version = RLPy.RApplication.GetProductVersion()
2 print(product_version)
3 if product_version < (8,0,0):
4 print("iClone 8 is still in development.")
RLPy.RApplication.GetProgramPath()
Get program path.
Returns
Program path - string
1 program_path = RLPy.RApplication.GetProgramPath()
2 print(program_path)
RLPy.RApplication.GetTemplateDataPath()
Get template data path.
Returns
Template data path - string
1 template_data_path = RLPy.RApplication.GetTemplateDataPath()
2 print(template_data_path)
