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