Remarks
Adds a trigger to the given player at a certain song position: when the trigger is reached, the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_TRIGGER_REACHED and you will be able to discriminate the specific trigger through its nData1 parameter: this parameter will match exactly the unique identification number assigned to the trigger.
See the How to add Triggers and Cue Points to a player section for further details about triggers.
Syntax
[Visual Basic]
Public Function TriggersAddPerc (
nPlayerIndex as Int16,
nTriggerID as Int16,
nTriggerPosPerc as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes TriggersAddPerc (
Int16 nPlayerIndex,
Int16 nTriggerID,
Int32 nTriggerPosPerc
);
|
|
[C++]
public: enumErrorCodes TriggersAddPerc (
Int16 nPlayerIndex,
Int16 nTriggerID,
Int32 nTriggerPosPerc
);
|
|
Parameter
|
Description
|
|
|
nPlayer
|
Number representing the zero-based index of the involved player
|
nTriggerID
|
Number representing the identifier of the new trigger. If this identifier should be already assigned to another trigger, an error code would be returned.
|
nTriggerPosPerc
|
Number representing the trigger position expressed in percentage.
If this position should be already assigned to another trigger, an error code would be returned.
|
Return value
Value
|
Meaning
|
|
|
Negative value
|
An error occurred (see the LastError property for further error details)
|
enumErrorCodes.NOERROR (0)
|
The method call was successful.
|
|