Difference between revisions of "IC Python API:RLPy RIBase"

From Reallusion Wiki!
Jump to: navigation, search
m
m
Line 5: Line 5:
 
== Description ==
 
== Description ==
  
This is the base class for all scene objects such as '''RIAvatar''', '''RIProp''', '''RICamera''', etc.  Deployed objects might come across some points of operation failure during the course of one's work with the scene, e.g. deletion, undo/redo operations, file importation, etc.  Therefore, '''RIBase''' provides '''IsValid()''' to detect for scene objects' validity.
+
This is the base class for all scene objects such as [[IC_Python_API:RLPy_RIAvatar|RIAvatar]], [[IC_Python_API:RLPy_RIProp|RIProp]], [[IC_Python_API:RLPy_RICamera|RICamera]], etc.  Deployed objects might come across some points of operation failure during the course of one's work with the scene, i.e. deletion, undo/redo operations, file importation, etc.  Therefore, [[IC_Python_API:RLPy_RIBase|RIBase]]provides [[#IsValid ( self )|IsValid]] to detect for scene objects' validity.
  
 
== Member Functions ==
 
== Member Functions ==
Line 11: Line 11:
 
=== IsValid ( self ) ===
 
=== IsValid ( self ) ===
  
Check whether or not the scene object exists; If detection fails, return '''False'''.  Call '''IsValid()''' to determine the validity of the object or use an EventCallback to update the state of the object after an event is triggered.
+
Check whether or not the scene object exists; If detection fails, return '''False'''.
  
 
==== Returns ====
 
==== Returns ====
:Valid or not - bool
+
:'''True''' if valid, else '''False''' - bool
 
+
<syntaxhighlight lang="Python">
+
import RLPy
+
  
 +
<syntaxhighlight lang="python">
 
avatar = None
 
avatar = None
 
event_callback = None
 
event_callback = None

Revision as of 23:58, 8 April 2020

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

Description

This is the base class for all scene objects such as RIAvatar, RIProp, RICamera, etc. Deployed objects might come across some points of operation failure during the course of one's work with the scene, i.e. deletion, undo/redo operations, file importation, etc. Therefore, RIBaseprovides IsValid to detect for scene objects' validity.

Member Functions

IsValid ( self )

Check whether or not the scene object exists; If detection fails, return False.

Returns

True if valid, else False - bool
avatar = None
event_callback = None

class REventCallbackSampleCode(RLPy.REventCallback):
    def __init__(self):
        RLPy.REventCallback.__init__(self)
    def OnObjectDeleted(self):
        global avatar
        if not avatar.IsValid():
            print ("The avatar has been deleted")

def run_script():
    global avatar
    global event_callback
    avatar_list = RLPy.RScene.GetAvatars()
    avatar = avatar_list[0] 
    event_callback = REventCallbackSampleCode()
    id = RLPy.REventHandler.RegisterCallback(event_callback)