IdaJS
    Preparing search index...

    Type Alias UserText

    UserText:
        | string
        | [string]
        | [string, number]
        | [string, number, DialogColor]
        | [string, number, DialogColor, string]
        | [string, number, DialogColor, string, number]
        | [string, number, DialogColor, string, number, number]
        | TextObject

    The user can specify the text entity in various forms, from just a string, to a full object.

    This is a union type that covers all the possible ways to define a text entity.

    • string - just a plain text with all the rest is default The text supports: \n - line break, special word @ - line break with space, special word @P - page break.
    • [string]: just a plain text with all the rest is default
    • [string, number]: [text, TextFlags]
    • [string, number, DialogColor]: [text, TextFlags, color]
    • [string, number, DialogColor, string]: [text, TextFlags, color, sprite]
    • [string, number, DialogColor, string, number]: [text, TextFlags, color, sprite, spriteOffsetX]
    • [string, number, DialogColor, string, number, number]: [text, TextFlags, color, sprite, spriteOffsetX, spriteOffsetY]
    • TextObject: full definition of what you would like to display in a dialog

    TextObject - for documentation about DialogColors, flags, sprite, offsets, etc.