Trigger

描述：

  输入触发器的管理类，定义了键盘键、游戏手柄按钮和摇杆的各种输入触发器。

KeyDown

类型： 函数。

描述：

  创建一个触发器，当所有指定的键被按下时触发。

签名：

KeyDown: function(combineKeys: KeyName | {KeyName}): Trigger

参数：

参数名	类型	描述
combineKeys	KeyName	{KeyName}

返回值：

返回类型	描述
Trigger	触发器对象。

KeyUp

类型： 函数。

描述：

  创建一个触发器，当所有指定的键被按下并且其中任何一个被释放时触发。

签名：

KeyUp: function(combineKeys: KeyName | {KeyName}): Trigger

参数：

参数名	类型	描述
combineKeys	KeyName	{KeyName}

返回值：

返回类型	描述
Trigger	触发器对象。

KeyPressed

类型： 函数。

描述：

  创建一个触发器，当所有指定的键正在被按下时触发。

签名：

KeyPressed: function(combineKeys: KeyName | {KeyName}): Trigger

参数：

参数名	类型	描述
combineKeys	KeyName	{KeyName}

返回值：

返回类型	描述
Trigger	触发器对象。

KeyHold

类型： 函数。

描述：

  创建一个触发器，当特定键被按下并且保持按下指定的持续时间时触发。

签名：

KeyHold: function(keyName: KeyName, holdTime: number): Trigger

参数：

参数名	类型	描述
keyName	KeyName	要检查的键。
holdTime	number	持续时间，以秒为单位。

返回值：

返回类型	描述
Trigger	触发器对象。

KeyTimed

类型： 函数。

描述：

  创建一个触发器，当特定键在指定的时间窗口内被按下时触发。

签名：

KeyTimed: function(keyName: KeyName, timeWindow: number): Trigger

参数：

参数名	类型	描述
keyName	KeyName	要检查的键。
timeWindow	number	时间窗口，以秒为单位。

返回值：

返回类型	描述
Trigger	触发器对象。

KeyDoubleDown

类型： 函数。

描述：

  创建一个触发器，当特定键被双击时触发。

签名：

KeyDoubleDown: function(key: KeyName, threshold?: number): Trigger

参数：

参数名	类型	描述
key	KeyName	要检查的键。
threshold	number	[可选] 双击的时间阈值，以秒为单位。默认为0.3。

返回值：

返回类型	描述
Trigger	触发器对象。

AnyKeyPressed

类型： 函数。

描述：

  创建一个触发器，当任何键被持续按下时触发。

签名：

AnyKeyPressed: function(): Trigger

返回值：

返回类型	描述
Trigger	触发器对象。

ButtonDown

类型： 函数。

描述：

  创建一个触发器，当所有指定的游戏手柄按钮被按下时触发。

签名：

ButtonDown: function(combineButtons: ButtonName | {ButtonName}, controllerId?: number): Trigger

参数：

参数名	类型	描述
combineButtons	ButtonName	{ButtonName}
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

ButtonUp

类型： 函数。

描述：

  创建一个触发器，当所有指定的游戏手柄按钮被按下并且其中任何一个被释放时触发。

签名：

ButtonUp: function(combineButtons: ButtonName | {ButtonName}, controllerId?: number): Trigger

参数：

参数名	类型	描述
combineButtons	ButtonName	{ButtonName}
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

ButtonPressed

类型： 函数。

描述：

  创建一个触发器，当所有指定的游戏手柄按钮正在被按下时触发。

签名：

ButtonPressed: function(combineButtons: ButtonName | {ButtonName}, controllerId?: number): Trigger

参数：

参数名	类型	描述
combineButtons	ButtonName	{ButtonName}
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

ButtonHold

类型： 函数。

描述：

  创建一个触发器，当特定的游戏手柄按钮被按下并且保持按下指定的持续时间后触发。

签名：

ButtonHold: function(buttonName: ButtonName, holdTime: number, controllerId?: number): Trigger

参数：

参数名	类型	描述
buttonName	ButtonName	要检查的游戏手柄按钮。
holdTime	number	持续时间，以秒为单位。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

ButtonTimed

类型： 函数。

描述：

  创建一个触发器，当特定的游戏手柄按钮在指定的时间窗口内被按下时触发。

签名：

ButtonTimed: function(buttonName: ButtonName, timeWindow: number, controllerId?: number): Trigger

参数：

参数名	类型	描述
buttonName	ButtonName	要检查的游戏手柄按钮。
timeWindow	number	时间窗口，以秒为单位。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

ButtonDoubleDown

类型： 函数。

描述：

  创建一个触发器，当特定的游戏手柄按钮被双击时触发。

签名：

ButtonDoubleDown: function(button: ButtonName, threshold?: number, controllerId?: number): Trigger

参数：

参数名	类型	描述
button	ButtonName	要检查的游戏手柄按钮。
threshold	number	[可选] 双击的时间阈值，以秒为单位。默认为0.3。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

AnyButtonPressed

类型： 函数。

描述：

  创建一个触发器，当任何游戏手柄按钮被持续按下时触发。

签名：

AnyButtonPressed: function(controllerId?: number): Trigger

参数：

参数名	类型	描述
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

JoyStick

类型： 函数。

描述：

  创建一个触发器，当特定的游戏手柄轴被移动时触发。

签名：

JoyStick: function(joyStickType: JoyStickType, controllerId?: number): Trigger

参数：

参数名	类型	描述
joyStickType	JoyStickType	要检查的操纵杆类型。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

JoyStickThreshold

类型： 函数。

描述：

  创建一个触发器，当操纵杆移动超过指定阈值时触发。

签名：

JoyStickThreshold: function(joyStickType: JoyStickType, threshold: number, controllerId?: number): Trigger

参数：

参数名	类型	描述
joyStickType	JoyStickType	要检查的操纵杆类型。
threshold	number	阈值，取值范围为0到1。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

JoyStickDirectional

类型： 函数。

描述：

  创建一个触发器，当操纵杆在容忍的偏差角度内朝特定方向移动时触发。

签名：

JoyStickDirectional: function(joyStickType: JoyStickType, angle: number, tolerance: number, controllerId?: number): Trigger

参数：

参数名	类型	描述
joyStickType	JoyStickType	要检查的操纵杆类型。
angle	number	方向的角度，以度为单位。
tolerance	number	容忍角度，以度为单位。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

JoyStickRange

类型： 函数。

描述：

  创建一个触发器，当操纵杆在指定范围内时触发。

签名：

JoyStickRange: function(joyStickType: JoyStickType, minRange: number, maxRange: number, controllerId?: number): Trigger

参数：

参数名	类型	描述
joyStickType	JoyStickType	要检查的操纵杆类型。
minRange	number	最小范围值，取值范围为0到1。
maxRange	number	最大范围值，取值范围为0到1。
controllerId	number	[可选] 游戏手柄控制器的ID。默认为0。

返回值：

返回类型	描述
Trigger	触发器对象。

Sequence

类型： 函数。

描述：

  创建一个触发器，当一组其他触发器同时进入完成状态时触发。

签名：

Sequence: function(triggers: {Trigger}): Trigger

参数：

参数名	类型	描述
triggers	{Trigger}	要检查的触发器。

返回值：

返回类型	描述
Trigger	触发器对象。

Selector

类型： 函数。

描述：

  创建一个触发器，当一组其他触发器中的任何一个进入完成状态时触发。

签名：

Selector: function(triggers: {Trigger}): Trigger

参数：

参数名	类型	描述
triggers	{Trigger}	要检查的触发器。

返回值：

返回类型	描述
Trigger	触发器对象。

Block

类型： 函数。

描述：

  当子触发器处于完成状态时，它将反过来报告为取消状态，用于阻塞触发器的事件。

签名：

Block: function(trigger: Trigger): Trigger

参数：

参数名	类型	描述
trigger	Trigger	要被阻塞的触发器。

返回值：

返回类型	描述
Trigger	触发器对象。