Nomenclature guidelines reference document

 

The goals of this nomenclature are:

 

-         Keep the tags short to limit data transfer

-         Help identification for easier debug

 

 

Rite mission name:

 

Formal expression:

 

“R_” + < album number (2 digits) > + “_” + < theme number (2 digits) >

 

 

Example:

 

R_10_02

 

 

Phrase tag:

 

During the phrase generation process, the mission name is added in front of the phrase tag with an underscore in between. This part will thus only cover tag nomenclature.

 

Tags are built in three parts: phrase type, action/objective type and contextual info.

 

Formal expression:

 

< Phrase type (1 letter) > + “_” + < Action/objective type (2-3 letters) > + “_” + < Contextual info >

 

 

Exemples :

 

P_T2_FORGERON_1

P_T2_FORGERON_1A

 

M_T2_FORGERON_1A

 

O_T2_FORGERON_1A

 

 

Phrase type:

 

-         Phrase (associated letter = P): Grammatically constructed sentence said by a bot or displayed through system message

 

-         Menu (associated letter = M) : Contextual menu text

 

-         Objectif (associated letter = O) : Custom objective text

 

 

Action/objective that generates the phrase:

 

-         Talk_to: Associated code = T2

 

-         Dyn_chat: Associated code = DC

 

-         Dyn_answer: Associated code = DA

 

-         Linear_dyn_chat_continue: Associated code = LDC

 

-         Linear_dyn_chat_fail: Associated code = LDF

 

-         Linear_dyn_chat_retry: Associated code = LDR

 

-         Sys_msg: Associated code = SM

 

-         Escort: Associated code = ES

 

-         Kill: Associated code = KI

 

-         Give_item: Associated code = GI

 

(To be completed)

 

 

Additional context  information:

 

-         Target bot name

 

-         Initiator bot name

 

-         Information on the phrase content

 

 

Final tags :

 

R_10_02_ O_KI_BANDITS_1

 

R_10_02_ M_T2_FORGERON_1

 

R_10_02_ P_LDF_BRIEF_1