IsCheckpointSphere: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
(Created page with "{{Welcome| desc=Checks whether a checkpoint is sphere or not.| params=<syntaxhighlight lang="lua">( checkpointId )</syntaxhighlight> <poem>::checkpointId : The ID of the target checkpoint whose shape is to be determined. </poem>| retvals=true if the checkpoint is sphere, false otherwise. This function throws error if invalid checkpointId is given.| example=<source lang="lua"> if(IsCheckpointStreamIn(checkpointId)) { local isSphere=IsCheckpointSphere(checkpointId); }| rel...")
 
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 6: Line 6:
retvals=true if the checkpoint is sphere, false otherwise. This function throws error if invalid checkpointId is given.|
retvals=true if the checkpoint is sphere, false otherwise. This function throws error if invalid checkpointId is given.|
example=<source lang="lua">
example=<source lang="lua">
if(IsCheckpointStreamIn(checkpointId))
if(IsCheckpointStreamedIn(checkpointId))
{
{
local isSphere=IsCheckpointSphere(checkpointId);
local isSphere=IsCheckpointSphere(checkpointId);
}|
}</source>|
relfuncs=*[[GetCheckpointRadius]]
relfuncs=*[[GetCheckpointRadius]]
*[[GetCheckpointColor]]
*[[GetCheckpointColor]]
*[[GetCheckpointPos]]
*[[GetCheckpointPos]]
*[[IsCheckpointStreamedIn]]
}}
}}

Latest revision as of 06:25, 9 November 2023


Description:
Checks whether a checkpoint is sphere or not.


Parameters:

( checkpointId )

checkpointId : The ID of the target checkpoint whose shape is to be determined.


Return Values:
true if the checkpoint is sphere, false otherwise. This function throws error if invalid checkpointId is given.


Example

if(IsCheckpointStreamedIn(checkpointId))
{
local isSphere=IsCheckpointSphere(checkpointId);
}

Related Functions

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