Remarks
Enables/disable the given trigger.
See the How to add Triggers and Cue Points to a player section for further details about triggers.
Syntax
[Visual Basic]
Public Function TriggersEnable (
nPlayerIndex as Int16,
nTriggerID as Int16,
bEnable as Boolean
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes TriggersEnable (
Int16 nPlayerIndex,
Int16 nTriggerID,
bool bEnable
);
|
|
[C++]
public: enumErrorCodes TriggersEnable (
Int16 nPlayerIndex,
Int16 nTriggerID,
bool bEnable
);
|
|
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.
|
bEnable
|
Boolean value that specifies if the trigger must be enabled or disabled.
Supported values are the following:
Mnemonic constant
|
Meaning
|
false
|
Disable trigger
|
true (default)
|
Enable trigger
|
|
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.
|
|