GetCheckpointRadius: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Welcome|desc= Returns the radius of a checkpoint.| params=<source>( checkpointId )</source> <poem>checkpointId : The ID of the checkpoint whose radius is to be obtained. </poem>| retvals=The radius of checkpoint as float. Throws error if checkpoint with the specified ID is not found.| example=<source lang relfuncs=*GetCheckpointColor *GetCheckpointPos *GetCheckpointCount *ClaimEnterCheckpoint }}") |
No edit summary |
||
| Line 4: | Line 4: | ||
</poem>| | </poem>| | ||
retvals=The radius of checkpoint as float. Throws error if checkpoint with the specified ID is not found.| | retvals=The radius of checkpoint as float. Throws error if checkpoint with the specified ID is not found.| | ||
example=<source lang | example=<source lang="lua"> | ||
if(IsCheckpointStreamedIn( checkpointId)) | |||
{ | |||
local radius = GetCheckpointRadius( checkpointId); | |||
} | |||
</source> | |||
| | |||
relfuncs=*[[GetCheckpointColor]] | relfuncs=*[[GetCheckpointColor]] | ||
*[[GetCheckpointPos]] | *[[GetCheckpointPos]] | ||
*[[GetCheckpointCount]] | *[[GetCheckpointCount]] | ||
*[[ClaimEnterCheckpoint]] | *[[ClaimEnterCheckpoint]] | ||
*[[IsCheckpointStreamedIn]] | |||
}} | }} | ||
Latest revision as of 09:49, 12 November 2023
Description:
Returns the radius of a checkpoint.
Parameters:
( checkpointId )
checkpointId : The ID of the checkpoint whose radius is to be obtained.
Return Values:
The radius of checkpoint as float. Throws error if checkpoint with the specified ID is not found.
Example
if(IsCheckpointStreamedIn( checkpointId))
{
local radius = GetCheckpointRadius( checkpointId);
}Related Functions
The following functions may be helpful as they relate to this function in one way or another.