Skip to main content

Interface: LocalePickerOptions

Extends​

  • CompositeOptions

Properties​

alpha?​

optional alpha: number

Opacity of the node. 0 is fully transparent, 1 is fully opaque. Default is 1.0. Alpha has multiplicative inheritance. For example, if the node's parent is alpha .5 and this node's is alpha .4, then the node will appear with alpha .2.

Inherited from​

CompositeOptions.alpha

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:100

anchorPoint?​

optional anchorPoint: Point

Point within the node that determines its position. Default is { x: 0.5, y: 0.5 }, which centers the node on its position

Inherited from​

CompositeOptions.anchorPoint

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:43

automaticallyChangeLocale?​

optional automaticallyChangeLocale: boolean

Should the selection in the LocalePicker automatically switch the game's locale? Default is true.

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:44

backgroundColor?​

optional backgroundColor: RgbaColor

Background color of dialog box. Default is WebColors.White

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:24

cornerRadius?​

optional cornerRadius: number

Corner radius of dialog box; can be used to make rounded corners

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:34

currentLocale?​

optional currentLocale: string

What to show as the currently selected locale in the picker. Default is the game's current locale.

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:28

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

CompositeOptions.draggable

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:106

fontColor?​

optional fontColor: RgbaColor

Font color of locale options in dialog box. Default is WebColors.Black

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:38

fontSize?​

optional fontSize: number

Font size of locale options in dialog box. Default is 24.

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:36

hidden?​

optional hidden: boolean

Is the node, and its children, hidden? (not displayed). Default is false

Inherited from​

CompositeOptions.hidden

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:108

icon?​

optional icon: LocalePickerIcon

Image to use for LocalePicker. Default is a globe SVG, 32x32.

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:40

iconPosition​

iconPosition: Point

Position of the LocalePicker icon. Default is { x: 32, y: 32 }

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:42

isUserInteractionEnabled?​

optional isUserInteractionEnabled: boolean

Does the node respond to user events, such as taps? Default is false

Inherited from​

CompositeOptions.isUserInteractionEnabled

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:104

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

CompositeOptions.layout

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:110

localeOptions?​

optional localeOptions: LocaleOption[]

Locales to choose from in the dialog box. Default is the locales in the game's Translation.

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:26

name?​

optional name: string

Name of the node. Only needed if the node will be referred to by name in a later function

Inherited from​

CompositeOptions.name

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:94

overlayAlpha?​

optional overlayAlpha: number

Alpha level for the overlay that dims the scene underneath the dialog box. Default is .5

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:30

position?​

optional position: Point

Position of the node within its parent coordinate system. Default is (0, 0)

Inherited from​

CompositeOptions.position

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:96

scale?​

optional scale: number

Scale of the node. Default is 1.0

Inherited from​

CompositeOptions.scale

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:98

size?​

optional size: Size

Size of dialog box. Default is automatically sized to fit the number of locale options.

Defined in​

m2c2kit/packages/addons/src/composites/locale-picker.ts:32

suppressEvents?​

optional suppressEvents: boolean

Should the node not emit events to the EventStore? Default is false.

Remarks​

This property is for use by authors of Composite nodes. It is not intended for general use.

Inherited from​

CompositeOptions.suppressEvents

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:115

uuid?​

optional uuid: string

Internal

Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only

Inherited from​

CompositeOptions.uuid

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:112

zPosition?​

optional zPosition: number

Value along the z-axis to determine drawing and tap order. Larger values are on top.

Inherited from​

CompositeOptions.zPosition

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:45

zRotation?​

optional zRotation: number

Rotation of the node around the Z axis. Unit is radians. Default is 0 (no rotation). zRotation has inheritance. In addition to this node's zRotation, all ancestors' zRotations will be applied.

Inherited from​

CompositeOptions.zRotation

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:102