Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Game_Message

Hierarchy

  • Game_Message

Index

Constructors

constructor

Properties

_background

_choiceBackground

_choiceBackground: ChocieBackgroundType

_choiceCallback

_choiceCallback: (n: number) => void

Type declaration

    • (n: number): void
    • Parameters

      • n: number

      Returns void

_choiceCancelType

_choiceCancelType: ChoiceCancelType

_choiceDefaultType

_choiceDefaultType: ChoiceDefaultType

_choicePositionType

_choicePositionType: ChoicePositionType

_choices

_choices: string[]

_faceIndex

_faceIndex: number

_faceName

_faceName: string

_itemChoiceItypeId

_itemChoiceItypeId: number

_itemChoiceVariableId

_itemChoiceVariableId: number

_numInputMaxDigits

_numInputMaxDigits: number

_numInputVariableId

_numInputVariableId: number

_positionType

_positionType: MessagePositionType

_scrollMode

_scrollMode: boolean

_scrollNoFast

_scrollNoFast: boolean

_scrollSpeed

_scrollSpeed: number

_texts

_texts: string[]

Methods

add

  • add(text: string): void

allText

  • allText(): string

background

  • background(): number

choiceBackground

  • choiceBackground(): number

choiceCancelType

  • choiceCancelType(): number

choiceDefaultType

  • choiceDefaultType(): number

choicePositionType

  • choicePositionType(): number

choices

  • choices(): string[]

clear

  • clear(): void

faceIndex

  • faceIndex(): number

faceName

  • faceName(): string

hasText

  • hasText(): boolean

initialize

  • initialize(): void

isBusy

  • isBusy(): boolean

isChoice

  • isChoice(): boolean

isItemChoice

  • isItemChoice(): boolean

isNumberInput

  • isNumberInput(): boolean

itemChoiceItypeId

  • itemChoiceItypeId(): number

itemChoiceVariableId

  • itemChoiceVariableId(): number

newPage

  • newPage(): void

numInputMaxDigits

  • numInputMaxDigits(): number

numInputVariableId

  • numInputVariableId(): number

onChoice

  • onChoice(n: number): void

positionType

  • positionType(): number

scrollMode

  • scrollMode(): boolean

scrollNoFast

  • scrollNoFast(): boolean

scrollSpeed

  • scrollSpeed(): number

setBackground

  • setBackground(background: number): void
  • Sets the background of the message window; options are 0 (fully opaque), 1 (transparent), 2 (invisible background). The default is 0.

    memberof

    Game_Message

    Parameters

    • background: number

    Returns void

setChoiceBackground

  • setChoiceBackground(background: number): void

setChoiceCallback

  • setChoiceCallback(callback: (n: number) => void): void
  • Sets a callback to be associated with a specific choice; a callback is a JavaScript function that will be run when the choice is selected.

    memberof

    Game_Message

    Parameters

    • callback: (n: number) => void
        • (n: number): void
        • Parameters

          • n: number

          Returns void

    Returns void

setChoicePositionType

  • setChoicePositionType(positionType: number): void

setChoices

  • setChoices(choices: string[], defaultType: number, cancelType: number): void
  • Sets the choices within the choice window; sets the default and cancel choices for the window.

    memberof

    Game_Message

    Parameters

    • choices: string[]
    • defaultType: number
    • cancelType: number

    Returns void

setFaceImage

  • setFaceImage(faceName: string, faceIndex: number): void

setItemChoice

  • setItemChoice(variableId: number, itemType: number): void
  • Sets the choice and associates it with a variable id; sets the itemtype id associated with the choice.

    memberof

    Game_Message

    Parameters

    • variableId: number
    • itemType: number

    Returns void

setNumberInput

  • setNumberInput(variableId: number, maxDigits: number): void
  • Sets the number input and associates it with a variable id; the max number of digits can also be set.

    memberof

    Game_Message

    Parameters

    • variableId: number
    • maxDigits: number

    Returns void

setPositionType

  • setPositionType(positionType: number): void

setScroll

  • setScroll(speed: number, noFast: boolean): void
  • Sets the scroll speed of the message window; disable fast movement if noFast is set to true.

    memberof

    Game_Message

    Parameters

    • speed: number
    • noFast: boolean

    Returns void

Generated using TypeDoc