phaser4-rex-plugins/templates/scenario/yamlscenario/readme/textbox-commands.md

Plugins of phaser4

# Text-box commands

## Style of wait-icon

```javascript
{
  action: { width: 40, height: 40, animationMode: 'downArrow' },
}
```

- `animationMode` :
    - `undefined` : Play random spinner animation.
    - `'leftArrow' ` : Play *leftArrow* spinner animation.
    - `'rightArrow'` : Play *rightArrow* spinner animation.
    - `'upArrow'` : Play *upArrow* spinner animation.
    - `'downArrow'` : Play *dowbArrow* spinner animation.
    - `'audio'` : Play *audio* spinner animation.
    - `'ball'` : Play *ball* spinner animation. 
    - `'bars'` : Play *bars* spinner animation. 
    - `'box'` : Play *box* spinner animation.
    - `'clock'` : Play *clock* spinner animation.
    - `'cube'` : Play *cube* spinner animation.
    - `'dots'` : Play *dots* spinner animation.
    - `'facebook'` : Play *facebook* spinner animation.
    - `'grid'` : Play *grid* spinner animation.
    - `'hearts'` : Play *hearts* spinner animation.
    - `'ios'` : Play *ios* spinner animation.
    - `'oribit'` : Play *oribit* spinner animation. 
    - `'oval'` : Play *oval* spinner animation.
    - `'pie'` : Play *pie* spinner animation.
    - `'puff'` : Play *puff* spinner animation.
    - `'radio'` : Play *radio* spinner animation.
    - `'rings'` : Play *rings* spinner animation.
    - `'spinner'` : Play *spinner* spinner animation.

## Create Game Object Instance

```yaml
- name: TEXTBOX
  parameters:
    id: NAME
    width: 0
    height: 0  
    vpx: 0.5
    vpy: 1
    vpw: 
    vph: 
    frameDelimiter: "-"
    clickTarget: 
    clickShortcutKeys: 
    fastTypingShortcutKeys: 
```

Create TextBox as Text-box game object

- Default origin is `(0.5, 1)`
- `clickTarget` : Click target to type next page, or finish typing
    - `screen` : Any click on screen to type next page, or finish typing
    - `textbox` : Click on textbox to type next page, or finish typing
    - `null` : Disable this feature
- `clickShortcutKeys` : Press keyboard's key to type next page, or finish typing
    - Key string combined by `'|'`, default value is `'SPACE|ENTER'`
    - `null` : Disable this feature
- `fastTypingShortcutKeys` : Press keyboard's key to enable fastTyping, release key to disable fastTyping.
    - Key string combined by `'|'`, default value is `'CTRL'`
    - `null` : Disable this feature

## Destroy

```yaml
- name: NAME.destroy
```

## Set properties

```yaml
- name: NAME.set
  parameters:
    x: 
    vpx: 
    y: 
    vpy: 
    alpha: 
    duration: 1000
    ease: Linear
    repeat: 0
    wait: 
```

## Ease properties

```yaml
- name: NAME.to
  parameters:
    x: 
    vpx: 
    y: 
    vpy: 
    alpha: 
    duration: 1000
    ease: Linear
    repeat: 0
    wait: 
```

or

```yaml
- name: NAME.yoyo
  parameters:
    x: 
    vpx: 
    y: 
    vpy: 
    alpha: 
    duration: 1000
    ease: Linear
    repeat: 0
    wait: 
```

## Call methods

### Typing

```yaml
- name: NAME.typing
  parameters:
    displayName: 
    icon: 
    iconFrame: 
    name: 
    expression: 
    more: false
    text: 
    typingSpeed: 
    iconCrossDuration: 
    iconCrossMode: 'crossFade'
    waitIconAnimationMode:
    clickAfterComplete: true
    wait: true
```

- `displayName` : Display `displayName` at title element.
    - `null` : Hide title element.
    - `undefined` : Don't change title element.
- `icon`, `iconFrame` : Texture key and frame name of icon element.
  - `undefined` : Using previous texture.
  - Set `icon` to `null` : Hide icon element.
- `expression` : Generate `iconFrame` by `${name}-${expression}`.
- `iconCrossMode` : Pre-build effects
    - Fade effects : 
        - `'fade'` : Tint old image to black, then tint new image from black to origin color.
        - `'crossFade'` : Ease alpha of old image from 1 to 0, and ease alpha of new image from 0 to 1 at the same time.
    - Slide effects : `'slideLeft'`, `'slideRight'`, `'slideUp'`, `'slideDown'`, 
      `'slideAwayLeft'`, `'slideAwayRight'`, `'slideAwayUp'`, `'slideAwayDown'`, 
      `'pushLeft'`, `'pushRight'`, `'pushUp'`, `'pushDown'`.
    - Zoom(scale) effects : `'zoomOut'`, `'zoomIn'`, `'zoomInOut'`.
    - Mask effects : `'wipeLeft'`, `'wipeRight'`, `'wipeUp'`, `'wipeDown'`,
      `'irisOut'`, `'irisIn'`,  `'irisInOut'`, `'pieOut'`, `'pieIn'`, `'pieInOut'`, 
      `'blinds'`, `'squares'`, `'diamonds'`, `'circles'`, `'curtain'`.
    - Shader effects : `'pixellate'`, `'dissolve'`, 
      `'revealLeft'`, `'revealRight'`, `'revealUp'`, `'revealDown'`
- `more` :
  - `false` : Clear and start a new typing task. Default behavior.
  - `true` : Append text and continue typing.
- `clickAfterComplete` : 
  - `false` : if `wait` is `true`, wait until typing complete
  - `true` : Wait until typing complete, then one more clicking. Default behavior.
- `wait` :
  - `false` : If `clickAfterComplete` is `false`, running next command immediately.
  - `true` : If `clickAfterComplete` is `false`, wait until typing complete. Default value is `true`.

Wait an extra clicking after typing complete internally.

### Shake

```yaml
- name: NAME.shake
  parameters:
    duration: 
    magnitude: 
    wait: true
```