Enumeration ShortcutBindingFlag

A set of flags that can be used to customize the behavior of a shortcut key binding.

Constructors

`Protected`constructor

new ShortcutBindingFlag(do_not_, construct_, this_, type_): ShortcutBindingFlag
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns ShortcutBindingFlag

Values

`Static` `Readonly`CreatedFromMetadata

CreatedFromMetadata = 32

Specifies that the shortcut was created from metadata on the scripting class.

`Static` `Readonly`DisableLocaleTranslation

DisableLocaleTranslation = 16

If set, the shortcut manager will not tranlate the shortcut's binding button code. By default they are translated to make sure the shortcut is bound to the same character on different locale. For example this is the case for Undo, ctrl+Z, as key Z have a different location on a german keyboard.

`Static` `Readonly`DisablePlatformTranslation

DisablePlatformTranslation = 4

If set, the shortcut manager won't perform any translation of the shortcut to match the native platform shortcut style. This is usually set when the user has manually defined a shortcut binding or the shortcut must be used exactly as defined, independent on the platform it's currently used.

`Static` `Readonly`IgnoreExclusiveInput

IgnoreExclusiveInput = 8

If set, the shortcut will be considered exclusive for input. That is, it will trigger even if a the UI has exclusive keyboard input.

`Static` `Readonly`NoDelay

NoDelay = 2

If set with Repeating, the shortcut won't wait before sending the repeated triggers.

`Static` `Readonly`None

None = 0

Special flag that doesn't set any bit.

`Static` `Readonly`Repeating

Repeating = 1

If set, the shortcut action will be trigger repeatedly for as long as the keys are held down.

`Static` `Readonly`WindowGlobal

WindowGlobal = 64

Specifies that the shortcut should be added to the window global context rather than the local one.

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration ShortcutBindingFlag

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns ShortcutBindingFlag

Values

Static ReadonlyCreatedFromMetadata

Static ReadonlyDisableLocaleTranslation

Static ReadonlyDisablePlatformTranslation

Static ReadonlyIgnoreExclusiveInput

Static ReadonlyNoDelay

Static ReadonlyNone

Static ReadonlyRepeating

Static ReadonlyWindowGlobal

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetValues

Type Parameters

Returns EnumValueTyped<T, number>[]

StatichasFlag

Type Parameters

Parameters

Returns boolean

StatichasFlagChanged

Type Parameters

Parameters

Returns boolean

StaticiterateNames

Returns Generator<string, any, any>

StaticiterateValues

Type Parameters

Returns Generator<EnumValueTyped<T, number>, any, any>

StaticremoveFlag

Type Parameters

Parameters

Returns K

StaticsplitFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>[]

Settings

On This Page

`Protected`constructor

`Static` `Readonly`CreatedFromMetadata

`Static` `Readonly`DisableLocaleTranslation

`Static` `Readonly`DisablePlatformTranslation

`Static` `Readonly`IgnoreExclusiveInput

`Static` `Readonly`NoDelay

`Static` `Readonly`None

`Static` `Readonly`Repeating

`Static` `Readonly`WindowGlobal

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags