Editing NpcMsg - Checks CheatSheet

Thank you to Crosstine for the base of these notes!

== Quest Checks ==
'''''Note''': All Quest-related checks are pre-set in [<u>[[NpcTalk CheatSheet|NpcTalk_@@@]]</u>] and then subsequently created [<u>QuestResult_###</u>] tables''

'''NOTE''': All regular integers (e.g. '''1/2/3/4/5/etc.''') -> '''NpcMsg''' <ROW> ID's ; '''q0,q1,q2,etc.''' = '''QuestResult_### Table''' with the # in q# determining which row to use (starts at 0)

'''<code>\Quest_Check,1,2,3,4</code>'''<blockquote>1 - Dialogue after accepting. (Into \Quest_Accept)

2 - Dialogue for bringing quest items. (Into \Quest_Complete)

3 - Dialogue to remind you what to do.

4 - Dialogue after clearing the quest as thanks.</blockquote>'''<code>\Quest_Accept,q0,q1,5</code>'''<blockquote>q0 - Dialogue of accepting quest. 

q1 - Dialogue of taking too many quests at once. 

5 - Dialogue of not within level range. </blockquote>'''<code>\Quest_Complete,q2,q3,4</code>'''<blockquote>q2 - Dialogue to accept/decline the same quest. (Can be ignored if quest limit is 1.)

q3 - Dialogue of inventory being full.

4 - Dialogue after clearing the quest as thanks.</blockquote><blockquote>''Reminder: All "q1,q2,q3,etc" refer to the [Msg] used in QuestResult tables''.

'''NOTE''': ''Sole numbers after checks -> dialogue rows to jump to in case of said error''</blockquote>

e.g. '''<code>\Quest_Check,5,6,12,8</code>'''<blockquote>5 - Dialogue after accepting. (Into \Quest_Accept)

6 - Dialogue for bringing quest items. (Into \Quest_Complete)

12 - Dialogue to remind you what to do.

8 - Dialogue after clearing the quest as thanks.</blockquote><code>'''\Quest_Once_Accept,q2,q3,4,5'''</code>

'''Note''': This is for dailies<blockquote>

q2 - Quest Dialogue of accepting the quest

q3 - Quest Dialogue of inventory being full

4 - Level requirement not met

5 - "Come Back Tomorrow"

<code>'''\CheckQuestState,4,10'''</code> - Checks <CheckQuestID> in NpcTalk

4 - Check passed

10 - Check failed

</blockquote>

==== '''Scenario Quest / Episode Quest Checks''' ====
<blockquote>

<code>'''\S_QuestCheck,2,3,4,7'''</code>

2 - Haven't accepted yet

3 - If you've brought the materials

4 - If you're missing the materials

7 - If you already finished the quest

<code>'''\S_QuestCheck_#,2,3,4,5'''</code>- Checks <'''QuestID'''> in [[NpcTalk CheatSheet|NpcTalk]] from ['''ScenarioQuestInfo'''] table, first value (0) <u>not</u> _# (<code>\S_QuestCheck</code>)

2 - Haven't accepted yet

3 - If you've brought the materials

4 - If you're missing the materials

5 -If you already completed the quest

'''<code>\S_Quest_Accept,q0,q1,10</code>''' - Accepts <'''QuestID'''> in [[NpcTalk CheatSheet|NpcTalk]] from ['''ScenarioQuestInfo'''] table

q0 - Dialogue of accepting quest. 

q1 - Dialogue of taking too many quests at once. 

10 - Dialogue of not within level range. 

<code>'''\S_Quest_Accept_#,q2,q3,7'''</code> - Accepts <'''QuestID#'''> in [[NpcTalk CheatSheet|NpcTalk]] from ['''ScenarioQuestInfo'''] table - Unsure "0" value for <code>\S_Quest_Accept_0</code>

q2 - Dialogue of accepting quest. 

q3 - Dialogue of taking too many quests at once. 

7 - Dialogue of not within level range. 

<code>'''\S_ActiveQuestID_#,1,2'''</code> - Checks <QuestID> in NpcTalk from [ScenatioQuestInfo] table, ID matches with slot - Starts with _0 (<code>\S_ActiveQuestID_0</code>)

1 - Quest Active

2 - Quest not active

<code>'''\S_Quest_Complete,q2,q3,3'''</code> - Completes the <QuestID> Scenario Quest

q2 - Dialogue to complete.

q3 - Dialogue of inventory being full.

4 - Dialogue after clearing the quest as thanks.

'''<code>\S_Quest_Complete_#,q0,q1,10</code>''' - Completes the second or beyond (starts from S_Quest_Complete_1 with QuestID1)

q0 - Dialogue to complete.

q1 - Dialogue of inventory being full.

10 - Dialogue after clearing the quest as thanks.</blockquote>

== Party Quest Checks ==
'''<code>\P_Quest_Check,1,8,7,2,3,4,5,6,9</code>'''<blockquote>1 - Condition met. Can accept party quest.

8 - Complete party quest and claim Exp/Tmxp reward.

7 - Turn in party quest and claim item rewards. Into P_Quest_Success dialogue.

2 - Quest already started. Dialogue of reminding you what to do.

3 - Condition failed. Active MQ/PQ detected amongst the party.

4 - Condition failed. The quest can only be done in a party.

5 - Condition failed. Only the party leader can accept this quest.

6 - Condition failed. Not everyone in your party is currently here.

9 - Condition failed. Someone in the party doesn't meet the level requirement.</blockquote>'''<code>\P_Quest_Accept,10,3,4,5,6,9</code>'''<blockquote>10 - Condition met. Dialogue after starting the party quest.

3 - Condition failed. Active MQ/PQ detected amongst the party.

4 - Condition failed. The quest can only be done in a party.

5 - Condition failed. Only the party leader can accept this quest.

6 - Condition failed. Not everyone in your party is currently here.

9 - Condition failed. Someone in the party doesn't meet the level requirement.

'''''Note''': The line containing the [P_Quest_Accept] must set the <NpcSType> to '3' to categorize this as a valid Party Quest.''</blockquote>'''<code>\P_Quest_Success,11,4,5,6</code>'''<blockquote>11 - Dialogue telling you and everyone in the party to claim their rewards.

4 - Condition failed. The quest can only be done in a party.

5 - Condition failed. Only the party leader can accept this quest.

6 - Condition failed. Not everyone in your party is currently here.</blockquote>'''<code>\P_Quest_Complete,12,13</code>'''<blockquote>12 - Condition met. Dialogue after receiving the item rewards.

13 - Condition failed. You either have 300 items or have exceeded the maximum weight.</blockquote>

== Etc. + Item Checks ==
'''<code>\CheckGender,1,2</code>'''<br>'''<code>\CheckHaveItem,1,2</code>'''<blockquote>1 - Condition is met.<br>2 - Condition is not met.</blockquote>'''<code>\Give_Item,1,2</code>'''<br>'''<code>\Take_Item,1,2</code>'''<blockquote>1 - Condition is met. Advance dialogue. <br>2 - Condition failed. You are carrying too much.

'''''Note''': Item-based checks are set in the relevant <u>[<nowiki/>[[NpcTalk CheatSheet|NpcTalk_@@@]]]</u> table.''</blockquote>'''<code>\Begin group conversation.\EventTalkStart</code>'''<blockquote>''Will point to [<u>NpcEventMsg</u>] or [<u>NpcEventTalk</u>] tables.''</blockquote>

== NPC Check References ==

=== Leonardo ===
'''<code>\Enter Egg Shop.\VIP_Shop</code>'''<blockquote>''Fun fact: Leonardo has a "\CheckGender" for no reason.''

'''''Note''': Set which on [[NpcTalk CheatSheet|NpcTalk]] table''</blockquote>

=== Recyclek Mk1 ===
'''<code>\Recycling Shop\RecycleCouponExchange</code>'''

'''<code>\Recycling Paid Items\InvenItemRecycle</code>'''

=== Fusion Master Arlene ===
'''<code>\Fuse equipment.\NewEquipComposing</code>'''

'''<code>\Disassemble equipment.\DecompoundItem</code>'''

=== Compounder Paul ===
'''<code>\Compound List.\Compound_Start,2</code>'''<blockquote>'''''Note''': Set which on [[NpcTalk CheatSheet|NpcTalk]] table''</blockquote>

=== Mint ===
'''<code>\Exchange List.\ExchangeShop_Start,1</code>'''<blockquote>'''''Note''': Set which on [[NpcTalk CheatSheet|NpcTalk]] table''</blockquote>

=== Alan ===
'''<code>\Let's Temper!\EquipReform</code>'''

=== Alchemist Nate ===
'''<code>\Perform Maturing Compound.\Item_Growth</code>'''

'''<code>\Remove Maturing Compound Item.\Reset_Mix</code>'''

=== Blacksmith Marx ===
'''<code>\Refine or repair an item.\Item_Refine</code>'''

=== Pet Breeder Erin ===
'''<code>\Let's fuse a pet.\PetComposing</code>'''

'''<code>\Let's Level up.\PetLevelUp</code>'''

=== Pet Trainer Shara ===
'''<code>\Equip Hardant.\PetReinforce</code>'''

'''<code>\Unequip Hardant.\PetReinforce_Reset</code>'''

'''<code>\Request Pet Training.\PetRetrain</code>'''

=== Pia ===
'''<code>\Recharge expired Time Limit item.\Item_ChargeTimer</code>'''

'''<code>\Retrieve item.\RetrieveUnitedItem_Start,1</code>'''<blockquote>1 - Here you go~</blockquote>

=== Banker Lisa ===
'''<code>\Use the bank\NeoWarehouse_Start,1,2,3</code>'''<blockquote>1 - (Doesn't exist. The <ROW> be ignored or skipped.)

2 - Level restriction condition: You have be at least Level 10 to use this service.

3 - Not enough galder condition: You do not have enough money. The service fee is 100 galders.</blockquote>

=== Lovely Angelina ===
'''<code>\Deposit/Withdraw Items\Warehouse_Start,1,2,3</code>'''<blockquote>1 - (Doesn't exist. The <ROW> be ignored or skipped.)

2 - Level restriction condition: There is a Level 5 minimum requirement.

3 - Not enough galder condition: You don't have enough money. The service fee is 50 galders.</blockquote>

=== Guild Clerk Esther ===
'''<code>\Leave Guild.\GuildWithDraw_Process</code>'''

'''<code>\Cancel Guild Request.\GuildApplyCancel_Process</code>'''

'''<code>\Guild Member Bulletin Board.\GuildRecruitBulletin_Process</code>'''

'''<code>\Guild List.\GuildTotalGuild_Process</code>'''

=== Andrew ===
'''<code>\Change Guild Master Password.\GuildChangePassword</code>'''

'''<code>\Change Guild Name.\GuildChangeGuildName</code>'''

'''<code>\Change Guild Master.\GuildChangeMaster</code>'''

'''<code>\Dismantle a Guild.\GuildDissolve_Check</code>'''

'''<code>\Create a Guild.\GuildSetup_Ckeck,1,2,3</code>'''<blockquote>1. Condition is met.

2. Condition failed. Level requirement of 35 or higher.

3. Condition failed. Insufficient funds.</blockquote><blockquote>''Note: Yes, the check for "Create a Guild" is mispelled. Best left as is.''</blockquote>

=== Card Girl ===
'''<code>\Ask for more details on card battle masters.\NotifyCardBattleRank,1</code>'''<blockquote>1 - They are all grand masters of card battle here in Caballa Island.</blockquote>

=== Louis Bitton ===
'''<code>\I want to look beautiful!\DisguiseCharUI,1,2,3,4,5</code>'''<blockquote>1. Condition is met. Job changed successfully~

2. Condition failed. Inventory is full.

3. Condition failed. Job Advancment required.

4. Condition failed. Not enough galder. (The service fee is 50,000 galder.)

5. Condition failed. You can't use this service while using a Disguise Kit.</blockquote>

=== Kyu ===
'''<code>\May I see the Reservations?\OpenMarriageRoom</code>'''

'''<code>\Show me the Public Wedding Board.\OpenMarriageBoard</code>'''

=== Star Gazer Stella ===
'''<code>\What's today's fortune?\99</code>'''

'''<code>\Read fortune.\EnterFortuneHouse,50</code>'''<blockquote>50 - You're short on galder.

99 - I'm sure Star Gazer Stella won't mind me doing this... Here is today's reading for you.\@\@ref,tc</blockquote>'''<code>\@\@ref,tc</code>'''<blockquote>''Daily fortune of the day prompt. Place at the end of the dialogue string.''</blockquote>

=== Door of Tribulation ===
'''<code>\WarpGateSkill,8</code>''' <blockquote>8 - Condition failed. Reject dialogue. (?)</blockquote>

=== Dimensional Jewel ===
'''<code>\WarpGateSkill_CM,8</code>''' <blockquote>8 - Condition failed. Reject dialogue.</blockquote>

== Advanced Dialogue ==
<blockquote>''Commands used for dialogues. These are generally placed at the end of the dialogue string.''

''Order doesn't seem to matter if using each of these at once.''</blockquote>'''<code>\*\*block</code>'''<blockquote>''Prevents the player from leaving the conversation by clicking outside the dialogue window.''

'''Example''': You can't leave this text prompt until you click "Exit": ''Thank you~" okay?\Thank you~\Exit\*\*block''

'''Example 2''': Below is a softlock. You made the dialogue line 15 loop back to itself.</blockquote><blockquote><code>''Line 15:''

You are stuck... You can only press ESC and either Log Out or Exit Game to leave at this point.\Clicking this will loop the same line.\15\*\*block</code></blockquote>'''<code>\@\@img,i<ItemID></code>'''<blockquote>''Replace <ItemID> with an existing ID from <u>ItemParam2/CM2</u> to display an item.''

'''Example''': \@\@img,i106

'''Example 2''': <u>RandomTableID0</u> contains the following items below...\Next.\17\@\@img,i105,i101,i102</blockquote><code>'''\Random_Msg,#,#,#,#,#'''</code><blockquote>Seems to display a random message after clicking, based on the Row #'s put after</blockquote>

=== Teleporting ===
'''Note''': These require the [<u>TeleportInfo</u>] table to complete. Best for "commercial" services.

<code>'''\Teleport_Start,0'''</code><blockquote>Starts the teleport for the user

0 - fail number (condition not met)</blockquote><code>'''\Teleport_Check,1,2,3,4'''</code><blockquote>1 - Teleport ID # in [<u>TeleportInfo</u>]

2 - Check Passed

3 - Level restriction failed

4 - Galder restriction failed</blockquote>

=== General Movement ===
'''Note''': These rely on the [<u>NpcMoveInfo</u>] table to complete. Best for free or item-based teleports.

<code>'''\Move_Check,1,2,3,4,5'''</code><blockquote>1 - Check Passed, move dialogue to 6 (add move complete to "1" row in this instance, see below)

2 - Check failed; item is missing

3 - Check failed; level restriction

4 - Check failed; error failsafe

5 - Check failed; another error failsafe</blockquote><code>'''\Move_Complete,6'''</code><blockquote>6 - NPC Dialogue to say while teleporting</blockquote>

== Other Checks to Note ==
<code>'''\Add a combination slot (Future Update!)\SlotExtend'''</code><blockquote>Currently not implemented, just for recording purposes.</blockquote>'''<code>\ItemStatCheck1,14,20,21</code>'''<blockquote>14 - Condition met. Advance dialogue.

20 - Condition not met. Task incomplete.

21 - Condition failed. Equipment is missing.</blockquote>'''<code>\CheckEnterPartyZone,1,2</code>'''<blockquote>1 - Condition met. Advance dialogue, clear to enter.

2 - Condition not met. Reject dialogue, boss hunt on cooldown. (You can re-enter in ## minutes.)

Note: The table [<u>PartyZoneInfo]</u> is where the "limitMinutesReEnter" can be adjusted.</blockquote>'''<code>\Check_Job,5,15</code>'''<blockquote>5 - Condition met. Advance dialogue.

15 - Condition not met. Reject dialogue.</blockquote>
[[Category:Cheatsheet]]
[[Category:XML]]
[[Category:Crosstine]]
[[Category:Libconfig]]