AimAssistCategorySettings Class

Settings used with AimAssistRegistry.addCategory for creation of the AimAssistCategory.

Properties

defaultBlockPriority

defaultBlockPriority: number;

Optional. Default targeting priority used for block types not provided to setBlockPriorities.

Type: number

Notes:

• This property can't be edited in restricted-execution mode.

defaultEntityPriority

defaultEntityPriority: number;

Optional. Default targeting priority used for entity types not provided to setEntityPriorities.

Type: number

Notes:

• This property can't be edited in restricted-execution mode.

identifier

read-only identifier: string;

The unique Id used to register the category with. Must have a namespace.

Type: string

Methods

• constructor
• getBlockPriorities
• getBlockTagPriorities
• getEntityPriorities
• getEntityTypeFamilyPriorities

• setBlockPriorities

• setBlockTagPriorities

• setEntityPriorities

• setEntityTypeFamilyPriorities

constructor

new AimAssistCategorySettings(identifier: string)

Constructor that takes a unique Id to associate with the created AimAssistCategory. Must have a namespace.

Parameters

• identifier: string

Returns AimAssistCategorySettings

getBlockPriorities

getBlockPriorities(): Record<string, number>

Gets the priority settings used for block targeting.

Returns Record<string, number> - The record mapping block Ids to their priority settings. Larger numbers have greater priority.

getBlockTagPriorities

getBlockTagPriorities(): Record<string, number>

Gets the priority settings used for block targeting.

Returns Record<string, number> - The record mapping block tags to their priority settings. Larger numbers have greater priority.

getEntityPriorities

getEntityPriorities(): Record<string, number>

Gets the priority settings used for entity targeting.

Returns Record<string, number> - The record mapping entity Ids to their priority settings. Larger numbers have greater priority.

getEntityTypeFamilyPriorities

getEntityTypeFamilyPriorities(): Record<string, number>

Gets the priority settings used for entity targeting.

Returns Record<string, number> - Map entity type families to their priority settings in a Record. Larger numbers have greater priority.

setBlockPriorities

setBlockPriorities(blockPriorities: Record<string, number>): void

Sets the priority settings used for block targeting.

Parameters

• blockPriorities: Record<string, number>

  A record mapping block Ids to their priority settings. Larger numbers have greater priority.

Notes:

• This function can't be called in restricted-execution mode.

setBlockTagPriorities

setBlockTagPriorities(blockTagPriorities: Record<string, number>): void

Sets the priority settings used for block targeting.

Parameters

• blockTagPriorities: Record<string, number>

Notes:

• This function can't be called in restricted-execution mode.

setEntityPriorities

setEntityPriorities(entityPriorities: Record<string, number>): void

Sets the priority settings used for entity targeting.

Parameters

• entityPriorities: Record<string, number>

  A record mapping entity Ids to their priority settings. Larger numbers have greater priority.

Notes:

• This function can't be called in restricted-execution mode.

setEntityTypeFamilyPriorities

setEntityTypeFamilyPriorities(entityTypeFamilyPriorities: Record<string, number>): void

Sets the priority settings used for entity targeting.

Parameters

• entityTypeFamilyPriorities: Record<string, number>

Notes:

• This function can't be called in restricted-execution mode.