UITextInput | 小游戏框架

Hierarchy

Touchable
- UITextInput

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UITextInput(entity: Entity2D): UITextInput

Overrides Touchable.constructor
- Defined in src/engine/game/2D/UITextInput.ts:155
Parameters
- entity: Entity2D
Returns UITextInput

Properties

editable

editable: boolean = true

Readonly entity

entity: Entity2D

物体对象。

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

onTextChange

onTextChange: Delegate<UITextInput, { text: string }> = ...

Readonly priority

priority: number = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

Align: number
Layout: number
Low: number
Physics: number
Render: number
Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Accessors

active

get active(): boolean
set active(value: boolean): void

- Defined in src/engine/game/component.ts:57
Returns boolean
- Defined in src/engine/game/component.ts:60
Parameters
- value: boolean
Returns void

activeInHierarchy

get activeInHierarchy(): boolean

- Defined in src/engine/game/component.ts:79
在场景树中是否active

readonly

memberof

Component

Returns boolean

align

get align(): TextAlign
set align(val: TextAlign): void

- Defined in src/engine/game/2D/UITextInput.ts:115
Returns TextAlign
- Defined in src/engine/game/2D/UITextInput.ts:118
Parameters
- val: TextAlign
Returns void

label

get label(): UILabel
set label(value: UILabel): void

- Defined in src/engine/game/2D/UITextInput.ts:37
Returns UILabel
- Defined in src/engine/game/2D/UITextInput.ts:40
Parameters
- value: UILabel
Returns void

maxChar

get maxChar(): number
set maxChar(val: number): void

- Defined in src/engine/game/2D/UITextInput.ts:91
Returns number
- Defined in src/engine/game/2D/UITextInput.ts:94
Parameters
- val: number
Returns void

multiline

get multiline(): boolean
set multiline(val: boolean): void

- Defined in src/engine/game/2D/UITextInput.ts:103
Returns boolean
- Defined in src/engine/game/2D/UITextInput.ts:106
Parameters
- val: boolean
Returns void

onClick

get onClick(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:272
点击事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchCancel

get onTouchCancel(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:232
触摸取消事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnd

get onTouchEnd(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:167
触摸结束事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnter

get onTouchEnter(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:193
触摸进入事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchLeave

get onTouchLeave(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:206
触摸离开事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchMove

get onTouchMove(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:180
触摸移动事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchOut

get onTouchOut(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:245
触摸掠过后移出事件，没有触发过触摸开始事件才能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchOver

get onTouchOver(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:219
触摸掠过事件，没有触发过触摸开始事件才能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchStart

get onTouchStart(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:154
触摸开始事件。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchUp

get onTouchUp(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:258
触摸掠过后移出事件，没有触发过触摸开始事件才能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

prompt

get prompt(): string
set prompt(val: string): void

- Defined in src/engine/game/2D/UITextInput.ts:61
Returns string
- Defined in src/engine/game/2D/UITextInput.ts:64
Parameters
- val: string
Returns void

promptColor

get promptColor(): Color
set promptColor(val: Color): void

- Defined in src/engine/game/2D/UITextInput.ts:74
Returns Color
- Defined in src/engine/game/2D/UITextInput.ts:77
Parameters
- val: Color
Returns void

text

get text(): string
set text(value: string): void

- Defined in src/engine/game/2D/UITextInput.ts:127
Returns string
- Defined in src/engine/game/2D/UITextInput.ts:130
Parameters
- value: string
Returns void

type

get type(): TextInputType
set type(val: TextInputType): void

- Defined in src/engine/game/2D/UITextInput.ts:49
Returns TextInputType
- Defined in src/engine/game/2D/UITextInput.ts:52
Parameters
- val: TextInputType
Returns void

Methods

destroy

destroy(): void

Inherited from Touchable.destroy
- Defined in src/engine/game/component.ts:133
Returns void

getTypeName

getTypeName(): string

Inherited from Touchable.getTypeName
- Defined in src/engine/game/component.ts:129
Returns string

isDetached

isDetached(): boolean

Inherited from Touchable.isDetached
- Defined in src/engine/game/component.ts:145
Returns boolean

resetProperties

resetProperties(): void

Inherited from Touchable.resetProperties
- Defined in src/engine/game/component.ts:169
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity2D

Returns UITextInput

Properties

editable

Readonly entity

Readonly id

Readonly isDestroyed

Readonly isDestroying

onTextChange

Readonly priority

Static Priority

Type declaration

Align: number

Layout: number

Low: number

Physics: number

Render: number

Tool: number

Static Optional Serialize

Type declaration

Parameters

Rest ...args: any[]

Returns any

Accessors

active

Returns boolean

Parameters

value: boolean

Returns void

activeInHierarchy

Returns boolean

align

Returns TextAlign

Parameters

val: TextAlign

Returns void

label

Returns UILabel

Parameters

value: UILabel

Returns void

maxChar

Returns number

Parameters

val: number

Returns void

multiline

Returns boolean

Parameters

val: boolean

Returns void

onClick

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchCancel

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnd

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnter

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchLeave

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchMove

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchOut

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchOver

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchStart

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchUp

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>