Interface TextApi

Colors

Flags

create

• create(textEntity?: UserText | UserTextFunction): number

  Register a new text entity and return its text ID.

  Parameters

  • OptionaltextEntity: UserText | UserTextFunction

    The text entity content. Empty string by default.

  Returns number

  The new text ID, that can be used in text zones or scripts.

  NB. If you want to use custom text in the life handlers, you should create just one text entity Id in the SceneEvents.afterLoadScene event, using this create function, store its Id to a variable, and then reuse it, by calling text.update function.

createChoices

• createChoices(): number[]

  A helper function that creates 10 text entities and returns their IDs in an array. This is useful for implementing dialog choices, where you need to have multiple text entities on the screen.

  Returns number[]

  An array of text IDs, that can be used in the dialog choices life calls.

  See

  • See the Bathroom or Storm samples for examples, on how to use custom dialog choices.
  • Use LifeOpcodes.LM_ADD_CHOICE, LifeOpcodes.LM_ASK_CHOICE, LifeOpcodes.LM_ASK_CHOICE_OBJ, LifeFunctions.LF_CHOICE to create choice-based dialogs in life scripts.

replace

• replace(textId: number, textEntity: UserText | UserTextFunction): number

  Replace an existing LBA game text entity by IdaJS controlled text.

  Leave the text empty to use the original game text, but change other parameters.

  If you also specify a custom text, you must specify the flags as well, or they will be set to default.

  Parameters

  • textId: number

    The text ID of the original game. See original game life scripts to see which text IDs are used in which situations, or read the Text.hqr file in an HQR editor.

  • textEntity: UserText | UserTextFunction

    The text entity content to replace the original game text with.

  Returns number

  The text ID

restore

• restore(textId: number): number

  Restore a game text entity to its original state.

  Parameters

  • textId: number

    The text ID

  Returns number

  The text ID

update

• update(textId: number, textEntity: UserText | UserTextFunction): number

  Update a registered text entity by its text ID.

  Use this in the life handlers. Create a dedicated text entity for life scripts once with text.create in the SceneEvents.afterLoadScene event, and then update its content dynamically in the life scripts with this function, each time you need to display some dialog.

  Parameters

  • textId: number

    The text ID of the entity you created with text.create.

  • textEntity: UserText | UserTextFunction

    The new text entity content.

  Returns number

  The text ID.