IsObjectTouchReportEnabled: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
(Created page with "{{Welcome|desc=Tells whether Touch Report is enabled for a particular object.| params=<source>( objectId )</source> <poem>objectId : The ID of the object whose property is to be checked. </poem>| example=<source lang="lua"> if( IsObjectStreamedIn( objectId ) && IsObjectTouchReportEnabled( objectId )) { ClaimObjectTouch( objectId ); } </source>| retvals= true if property is enabled, false otherwise. Throws error on invalid object ID.| relfuncs=*ClaimObjectTouch *IsO...")
 
No edit summary
 
Line 4: Line 4:
</poem>|
</poem>|
example=<source lang="lua">
example=<source lang="lua">
if( IsObjectStreamedIn( objectId ) && IsObjectTouchReportEnabled( objectId ))
if( IsObjectStreamedIn( objectId) && IsObjectTouchReportEnabled(objectId))
{
{
ClaimObjectTouch( objectId );
ClaimObjectTouch( objectId );

Latest revision as of 09:28, 12 November 2023


Description:
Tells whether Touch Report is enabled for a particular object.


Parameters:

( objectId )

objectId : The ID of the object whose property is to be checked.


Return Values:
true if property is enabled, false otherwise. Throws error on invalid object ID.


Example

if( IsObjectStreamedIn( objectId) && IsObjectTouchReportEnabled(objectId))
{
ClaimObjectTouch( objectId );
}

Related Functions

The following functions may be helpful as they relate to this function in one way or another.