WITH_TRA

[Gwendolyne_FP]

Maybe because English is not my native language, I don't understand the purpose of the following description:

Creates a new TRA scope copied from the surrounding scope, loads all traName files (variable substitution is done; the file can be inlined) and evaluates the TP2 Actions. When WITH_TRA exits, the new TRA scope is discarded, that is, all TRA changes made by WITH_TRA or any of its enclosed actions are forgotten.

Is it a substitution for COMPILE .... USING ?

I didn't find a single tp2 using it.

Could you clarify my misunderstanding and give me a simple and straightforward example explaining how and when it would be smart to use it ?

Thanks.

[Argent77]

I see WITH_TRA as a more general replacement of the "USING traFile" parameter (which is only available for a few selected TP2 actions).

Instead of writing

Code: [Select]

COMPILE ~mydialog.d~ USING ~mylines.tra~
OUTER_SET strref = RESOLVE_STR_REF(@1234)

and complaining that RESOLVE_STR_REF() can't load lines from custom TRA files, you can write the following code:

Code: [Select]

WITH_TRA ~mylines.tra~ BEGIN
  COMPILE ~mydialog.d~
  OUTER_SET strref = RESOLVE_STR_REF(@1234)
END

WITH_TRA is a new feature since WeiDU v240, so there aren't many mods using it already.

[Wisp]

It's a good idea to consider WITH_TRA whenever you have more than a single TRA file. Generally, WITH_TRA obsoletes USING (and to a some degree also LOAD_TRA). Additionally, since WITH_TRA has local scoping and can be nested, you do not necessarily need to worry about keeping your different TRA files free of overlap (e.g., you can start all your TRA files at 0).

As an example, I have this code in aTweaks:

Code: [Select]

  COPY_EXISTING baldur.bcs override
    DECOMPILE_AND_PATCH BEGIN
      REPLACE_TEXTUALLY ~\(SetGlobal("drowEraseJournal","GLOBAL",2)\)~ ~EraseJournalEntry(@58) EraseJournalEntry(@59) \1~
    END
  BUT_ONLY
@58 and@59 are pulled from a component-specific TRA file. Before, you needed to have them in setup.tra (e.g., QuestPack had a lot of this) and somehow cope with the associated difficulties (say, the need to have different text encoded in different charsets), or you have to do like me and use a very ugly hack involving LOAD_TRA. Now, you can just wrap the action in WITH_TRA and neatly solve the problem that way.

[Gwendolyne_FP]

Sorry for the delay. I forgot to answer.

Thanks for the examples. As I use a lot LOAD_TRA, I see now how I can use WITH_TRA.