IsObjectShotReportEnabled: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Welcome|desc=Tells whether Shot 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( IsObjectShotReportEnabled( objectId ) ) { ClaimObjectShot( objectId, 17 ); //17 is weapon. } </source>| relfuncs=*ClaimObjectShot *IsObjectTouchReportEnabled }}") |
No edit summary |
||
Line 4: | Line 4: | ||
</poem>| | </poem>| | ||
example=<source lang="lua"> | example=<source lang="lua"> | ||
if( IsObjectShotReportEnabled( objectId ) ) | if( IsObjectStreamedIn( objectId ) && IsObjectShotReportEnabled( objectId ) ) | ||
{ | { | ||
ClaimObjectShot( objectId, 17 ); //17 is weapon. | ClaimObjectShot( objectId, 17 ); //17 is weapon. | ||
} | } | ||
</source>| | </source>| | ||
retvals= true if property is enabled, false otherwise. Throws error on invalid object ID.| | |||
relfuncs=*[[ClaimObjectShot]] | relfuncs=*[[ClaimObjectShot]] | ||
*[[IsObjectTouchReportEnabled]] | *[[IsObjectTouchReportEnabled]] | ||
*[[IsObjectStreamedIn]] | |||
}} | }} |
Revision as of 09:23, 12 November 2023
Description:
Tells whether Shot 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 ) && IsObjectShotReportEnabled( objectId ) ) { ClaimObjectShot( objectId, 17 ); //17 is weapon. }
Related Functions
The following functions may be helpful as they relate to this function in one way or another.