GPC Developer Guides
...
Functions
Internal Functions

Combo Functions

Here is the list of the Combo Functions and Commands.

Combo Functions and Commands

Function

Description

combo_run

Runs a combo.

combo_running

Checks if a combo is running.

combo_stop

Stops a running combo.

combo_restart

Restarts a running combo.

combo_suspend

Suspends (pauses) a combo.

combo_suspended

Checks if a combo is in the suspended state.

combo_current_step

Gets the current step.

combo_step_time_left

Gets the time left of the currently executed step.

combo_stop_all

Stops all combos.

combo_suspend_all

Suspends (pauses) all combos.

combo_resume

Resumes the suspended combo.

combo_resume_all

Resumes all suspended combos.

combo_run

combo_run does precisely what the name suggests and runs a combo. However, unlike the combo_restart command, it has no effect if the combo is currently running. It will only start a combo if it is not already running.

GPC
ļ»æ

šŸ”“ Syntax

combo_run( <combo_name> );

āšŖ Parameters <combo_name> : The name assigned to a combo

šŸ”µ Returns

Nothing

combo_running

combo_running is a function that can be used in your code to check is a combo is running is not. If the combo named in its parameter is running, then it will return TRUE. If not, it will return FALSE.

GPC
ļ»æ

šŸ”“ Syntax

combo_running( <combo_name>);

āšŖ Parameters

<combo_name> : The name assigned to a combo

šŸ”µ Returns

TRUE if the combo is currently running and FALSE if it is not.

combo_stop

combo_stop does precisely what the name suggests and will stop a combo if it is running. As with combo_run, it has no effect if the combo is currently not running.

GPC
ļ»æ

šŸ”“ Syntax

combo_stop( <combo_name> );

ā€‹āšŖ Parameters

<combo_name> : The name assigned to a combo

šŸ”µ Returns

Nothing

combo_restart

combo_restart will restart a running combo. If the combo started within its parameters is currently running, it will be restarted from the beginning. If the combo is not currently running, it will be run.

GPC
ļ»æ

šŸ”“ Syntax

combo_restart( <combo_name> );

āšŖ Parameters

<combo_name> : The name assigned to a combo

šŸ”µ Returns

Nothing

combo_suspend

combo_suspend command suspends (pauses) a combo from running.

GPC
ļ»æ

šŸ”“ Syntax

combo_suspend( <combo_name> );

āšŖ Parameters

<combo_name> : The name assigned to a combo šŸ”µ Returns

Nothing

combo_suspended

combo_suspended Check to see if a combo is suspended.

GPC
ļ»æ

šŸ”“ Syntax

combo_suspended( <combo_name> );

ā€‹āšŖ Parameters

<combo_name> : Checks the name assigned to a combo if suspended šŸ”µ Returns

Nothing

combo_current_step

combo_current_step keywords returning the current step

GPC
ļ»æ

šŸ”“ Syntax

combo_current_step ( <combo_name> );

ā€‹āšŖ Parameters

<combo_name> : Checks the name assigned keywords returning the current step

šŸ”µ Returns

Nothing

combo_step_time_left

combo_step_time_left Checks the time left of the currently executed step

GPC
ļ»æ

šŸ”“ Syntax

combo_step_time_left( <combo_name> );

ā€‹āšŖ Parameters

<combo_name> : Checks the time left of the currently executed step

šŸ”µ Returns

Nothing

combo_stop_all

combo_stop_all Stops all combos from running.

GPC
ļ»æ

šŸ”“ Syntax

combo_stop_all ( <combo_name> );

āšŖ Parameters

<combo_name> : Stops all combos from running.

šŸ”µ Returns

Nothing

combo_suspend_all

combo_suspend_all Suspends all combos that is running.

GPC
ļ»æ

šŸ”“ Syntax

combo_suspend_all ( <combo_name> );

āšŖ Parameters

<combo_name> : Suspends all combos that is running.

šŸ”µ Returns

Nothing

combo_resume

combo_resume Will resume a combo if it is suspended or a running combo.

GPC
ļ»æ

šŸ”“ Syntax

combo_resume ( <combo_name> );

āšŖ Parameters

<combo_name> : resume a combo if it is suspended or a running combo.

šŸ”µ Returns

Nothing

combo_resume_all

combo_resume_all Will resume all combos if it is suspended or running combos.

GPC
ļ»æ

šŸ”“ Syntax

combo_resume_all ( <combo_name> );

āšŖ Parameters

<combo_name> : resume all combos if it is suspended or a running combos.

šŸ”µ Returns

Nothing

Combo Specific Commands

wait

wait command instructs the Virtual Machine within the Cronus on how long the last set of commands should be executed for. The length of time they instruct the VM to execute the commands is represented in milliseconds and can rand from 1ms to 32767ms (That's 1 millisecond to just over 32 seconds). The commands executed during the wait time are those placed between the current wait and the previous wait time, the current wait time and the previous call command, or the start of the combo, whichever comes first. As shown in the example below:

GPC
ļ»æ

šŸ”Ž Info: The wait command can only be used within a combo and must be at the first level of the combo block, it cannot be nested.

GPC
ļ»æ

šŸ”“Syntax

wait( <time> );

āšŖParameters

<time> : The length of time the last commands should be executed for represented in milliseconds ranging from 10 to 4000. šŸ”µReturns

Nothing

call

call command can only be used in combos and pauses the current combo to execute the combo called. Once the combo has finished, the previous combo is resumed.

GPC
ļ»æ

šŸ”“ Syntax

call( <combo_name );

āšŖ Parameters

<combo_name> : The name assigned to a combo

šŸ”µ Returns

Nothing