https://planeshift.top-ix.org//pswiki/api.php?action=feedcontributions&feedformat=atom&user=MagodraPSwiki - User contributions [en]2026-04-05T22:34:58ZUser contributionsMediaWiki 1.43.1https://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20223Quest Script Operations2014-01-10T23:39:05Z<p>Magodra: /* NPC tell */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>: <Message>[Narrate|actionmy|action]<br />
<br />
NPC respone to a player with a message. A block starting with [ and ending with ] will give a /narrate, /my or /me command. If the block do not start with the npc name it will be a narrate. If it starts with the npc name it will be a /me, and if ' follows the npc name it will be a /my.<br />
<br />
Ex: Harnquist: How do you do?[Harnquist looks down!]<br />
Harnquist: How do you do?[Harnquist' cat looks at you.]<br />
Harnquist: How do you do?[As he finishes talking, you notice clouds darkening on the horizon...]<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Trigger text><br />
<br />
Player tell npc. The text is the trigger text for the player message.<br />
<br />
<br />
Ex: P: hello<br />
P: Yes P: No<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20222Quest Script Operations2014-01-10T23:35:19Z<p>Magodra: /* NPC tell */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>: <Message>[Narrate|actionmy|action]<br />
<br />
NPC respone to a player with a message.<br />
<br />
Ex: Harnquist: How do you do?[Harnquist looks down!]<br />
Harnquist: How do you do?[Harnquist' cat looks at you.]<br />
Harnquist: How do you do?[As he finishes talking, you notice clouds darkening on the horizon...]<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Trigger text><br />
<br />
Player tell npc. The text is the trigger text for the player message.<br />
<br />
<br />
Ex: P: hello<br />
P: Yes P: No<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20221Quest Script Operations2014-01-10T23:34:17Z<p>Magodra: /* NPC tell */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>: <Message>[Narrate|actionmy|action]<br />
<br />
NPC respone to a player with a message.<br />
<br />
Ex: Harnquist: How do you do?[Harnquist looks down!]<br />
Harnquist: How do you do?[Harnquist' cat looks at you.]<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Trigger text><br />
<br />
Player tell npc. The text is the trigger text for the player message.<br />
<br />
<br />
Ex: P: hello<br />
P: Yes P: No<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20220Quest Script Operations2014-01-10T22:57:09Z<p>Magodra: /* NPC tell */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>: <Message>[Narrate|actionmy|action]<br />
<br />
NPC respone to a player with a message.<br />
<br />
Ex: Harnquist: How do you do?[Harnquist looks down!]<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Trigger text><br />
<br />
Player tell npc. The text is the trigger text for the player message.<br />
<br />
<br />
Ex: P: hello<br />
P: Yes P: No<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20219Quest Script Operations2014-01-10T22:51:34Z<p>Magodra: /* Player tell */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Trigger text><br />
<br />
Player tell npc. The text is the trigger text for the player message.<br />
<br />
<br />
Ex: P: hello<br />
P: Yes P: No<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20218Quest Script Operations2014-01-10T22:51:02Z<p>Magodra: /* Player tell */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
<br />
Ex: P: hello<br />
P: Yes P: No<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Custom_NPC_Dialogue&diff=20206Custom NPC Dialogue2014-01-04T21:17:37Z<p>Magodra: /* Referencing other NPCs */</p>
<hr />
<div>Custom NPC Dialogues are a subset of [[NPC Dialogues]] / [[Quest Script Operations]] that is include only functions that players can use to script NPCs. Actions that could be exploited to gain money or items is not included.<br />
<br />
= Limitation =<br />
<br />
== Referencing other NPCs ==<br />
Custon NPC Dialogues is not allowed to reference other NPCs. The NPC Tell command will be a generic syntax using the keyword NPC instead of the NPC Name. The "<NPC Name>:<message>." is not allowed. For Custom NPC Dialogues the syntax will be "NPC: <message>.".<br />
<br />
Syntax: NPC: <message>.<br />
<br />
Ex: NPC:Hello<br />
<br />
== Design ==<br />
This section contain description and rationales for the limitations that needs to be created.<br />
<br />
Possible ways to exploit the quest syntax by players writing their own quests.<br />
<br />
The following commands need to be blocked from use, or severely limited.<br />
<br />
<br />
* Quest command - Give [quantity] [quality] [item]<br />
** They will be able to spawn any item in the the BD with qualities upto 300/300<br />
** Preventative action - block access as it is not needed by players.<br />
<br />
<br />
* Quest command - [un]complete [quest name] [step x].<br />
** This will allow players to modify any quest in the game. Exploit as players could do anything they wanted with restarting/modifying/completing any quest in the game.<br />
** Preventative action - Limit the command to ONLY work with the quest it is written in. This must not be a generic feature as official quests use this cross quest referencing a lot.<br />
<br />
<br />
* Quest command - [un]setvariable [variable name] [value]<br />
** This would allow players to modify any variable in the game, would cause massive problems.<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - doadmincmd [command]<br />
** This would let the player run GM commands, clearly a massive exploit<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - run script [script name] [script variables]<br />
** This would let players run any script<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest menu trigger - Player gives [npc name] [value] [items]<br />
** This would allow players to trick other players into giving almost any item to an npc and they would not be able to recover the item. A player could for example use "Player gives test guard 10000000 tria."<br />
** Preventative action - This style of trigger should be removed from use by players. OR it should be modified such that in player written quests all giving by players MUST be MANUAL only, not automatic using the menu clicks.<br />
<br />
<br />
* Quest dialog - referencing other NPCs in quests.<br />
** Players should not be allowed to reference offical settings NPCs in their quests, this is to avoid players making NPCs saying stupid things which are completely against settings.<br />
** Preventative action - The only NPC which can be scripted in the player written quest is the NPC which was hired by the player.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Custom_NPC_Dialogue&diff=20205Custom NPC Dialogue2014-01-04T21:16:04Z<p>Magodra: /* Referencing other NPCs */</p>
<hr />
<div>Custom NPC Dialogues are a subset of [[NPC Dialogues]] / [[Quest Script Operations]] that is include only functions that players can use to script NPCs. Actions that could be exploited to gain money or items is not included.<br />
<br />
= Limitation =<br />
<br />
== Referencing other NPCs ==<br />
Custon NPC Dialogues is not allowed to reference other NPCs. The NPC Tell command will be a generic syntax using the keyword NPC instead of the NPC Name. The "<NPC Name>:<message>." is not allowed.<br />
<br />
Ex: NPC:Hello<br />
<br />
== Design ==<br />
This section contain description and rationales for the limitations that needs to be created.<br />
<br />
Possible ways to exploit the quest syntax by players writing their own quests.<br />
<br />
The following commands need to be blocked from use, or severely limited.<br />
<br />
<br />
* Quest command - Give [quantity] [quality] [item]<br />
** They will be able to spawn any item in the the BD with qualities upto 300/300<br />
** Preventative action - block access as it is not needed by players.<br />
<br />
<br />
* Quest command - [un]complete [quest name] [step x].<br />
** This will allow players to modify any quest in the game. Exploit as players could do anything they wanted with restarting/modifying/completing any quest in the game.<br />
** Preventative action - Limit the command to ONLY work with the quest it is written in. This must not be a generic feature as official quests use this cross quest referencing a lot.<br />
<br />
<br />
* Quest command - [un]setvariable [variable name] [value]<br />
** This would allow players to modify any variable in the game, would cause massive problems.<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - doadmincmd [command]<br />
** This would let the player run GM commands, clearly a massive exploit<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - run script [script name] [script variables]<br />
** This would let players run any script<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest menu trigger - Player gives [npc name] [value] [items]<br />
** This would allow players to trick other players into giving almost any item to an npc and they would not be able to recover the item. A player could for example use "Player gives test guard 10000000 tria."<br />
** Preventative action - This style of trigger should be removed from use by players. OR it should be modified such that in player written quests all giving by players MUST be MANUAL only, not automatic using the menu clicks.<br />
<br />
<br />
* Quest dialog - referencing other NPCs in quests.<br />
** Players should not be allowed to reference offical settings NPCs in their quests, this is to avoid players making NPCs saying stupid things which are completely against settings.<br />
** Preventative action - The only NPC which can be scripted in the player written quest is the NPC which was hired by the player.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Custom_NPC_Dialogue&diff=20204Custom NPC Dialogue2014-01-04T21:15:48Z<p>Magodra: </p>
<hr />
<div>Custom NPC Dialogues are a subset of [[NPC Dialogues]] / [[Quest Script Operations]] that is include only functions that players can use to script NPCs. Actions that could be exploited to gain money or items is not included.<br />
<br />
= Limitation =<br />
<br />
== Referencing other NPCs ==<br />
Custon NPC Dialogues is not allowed to reference other NPCs. The NPC Tell command will be a generic syntax using the keyword NPC instead of the NPC Name. The "<NPC Name>:<message>" is not allowed.<br />
<br />
Ex: NPC:Hello<br />
<br />
== Design ==<br />
This section contain description and rationales for the limitations that needs to be created.<br />
<br />
Possible ways to exploit the quest syntax by players writing their own quests.<br />
<br />
The following commands need to be blocked from use, or severely limited.<br />
<br />
<br />
* Quest command - Give [quantity] [quality] [item]<br />
** They will be able to spawn any item in the the BD with qualities upto 300/300<br />
** Preventative action - block access as it is not needed by players.<br />
<br />
<br />
* Quest command - [un]complete [quest name] [step x].<br />
** This will allow players to modify any quest in the game. Exploit as players could do anything they wanted with restarting/modifying/completing any quest in the game.<br />
** Preventative action - Limit the command to ONLY work with the quest it is written in. This must not be a generic feature as official quests use this cross quest referencing a lot.<br />
<br />
<br />
* Quest command - [un]setvariable [variable name] [value]<br />
** This would allow players to modify any variable in the game, would cause massive problems.<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - doadmincmd [command]<br />
** This would let the player run GM commands, clearly a massive exploit<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - run script [script name] [script variables]<br />
** This would let players run any script<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest menu trigger - Player gives [npc name] [value] [items]<br />
** This would allow players to trick other players into giving almost any item to an npc and they would not be able to recover the item. A player could for example use "Player gives test guard 10000000 tria."<br />
** Preventative action - This style of trigger should be removed from use by players. OR it should be modified such that in player written quests all giving by players MUST be MANUAL only, not automatic using the menu clicks.<br />
<br />
<br />
* Quest dialog - referencing other NPCs in quests.<br />
** Players should not be allowed to reference offical settings NPCs in their quests, this is to avoid players making NPCs saying stupid things which are completely against settings.<br />
** Preventative action - The only NPC which can be scripted in the player written quest is the NPC which was hired by the player.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20203Quest Script Operations2014-01-04T21:09:37Z<p>Magodra: /* Quest Script Operations */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests. A subset will be available for [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Response_Operation&diff=20202Response Operation2014-01-04T20:53:17Z<p>Magodra: </p>
<hr />
<div><br />
= Response Operations =<br />
<br />
Response operations are used to script response scripts as part of [[NPC Dialogues]]. They are also build internally in the server from the Quest system through [[Quest Script Operations]].<br />
== Action ==<br />
<br />
This response operations cause an action by the NPC. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|Mandatory<br />
|string<br />
|<br />
|Name of animation<br />
|-<br />
|text<br />
|Optional<br />
|string<br />
|<br />
|Action command.<br />
|}<br />
<br />
<br />
Ex: <action anim="The anim" text="The action" /><br />
<br />
== Action My ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <actionmy ... /><br />
<br />
== Action My Public ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <actionmypublic ... /><br />
<br />
== Action Public ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <actionpublic ... /><br />
<br />
== Assign Quest ==<br />
<br />
This response operations assign a new quest to the player. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|q1<br />
|Mandatory<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q2<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q2<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q3<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q4<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q5<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|timeout_msg<br />
|Optional<br />
|string<br />
|<br />
|The timeout message.<br />
|}<br />
<br />
<br />
Ex: <assign q1="The Quest" q2="The Other Quest" timeout_msg="The Quest timeout message" /><br />
<br />
== Complete Quest ==<br />
<br />
This response operations complete a quest. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest_id<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <complete quest_id="The Quest" error_msg="The Quest Complete error message" /><br />
<br />
== Do Admin Command ==<br />
<br />
This response operations run an admin command. In the command string the key words "targetchar" and "sourcenpc" is replaced with target and the NPC talking.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|command<br />
|Mandatory<br />
|string<br />
|<br />
|The admin command to run.<br />
|}<br />
<br />
<br />
Ex: <doadmincmd command="/debugnpc sourcenpc 5" /><br />
<br />
== Faction ==<br />
<br />
This response operations adjust the faction. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Mandatory<br />
|string<br />
|<br />
|Name of the faction.<br />
|-<br />
|value<br />
|Mandatory<br />
|integer<br />
|<br />
|The faction value.<br />
|}<br />
<br />
<br />
Ex: <faction name="My Faction" value="5" /><br />
<br />
== Give Item ==<br />
<br />
This response operations give items to the player. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|item<br />
|Mandatory<br />
|string or integer<br />
|<br />
|The name of the item stat or the id of the item stat.<br />
|-<br />
|count<br />
|Optional<br />
|integer<br />
|1<br />
|The number of items to give.<br />
|-<br />
|quality<br />
|Optional<br />
|integer<br />
|0<br />
|The quality of the new item.<br />
|}<br />
<br />
<br />
Ex: <give item="The Item" count="2" quality="50" /><br />
<br />
== Guild Award ==<br />
<br />
This response operations award a guild Karma Points. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|karma<br />
|Mandatory<br />
|integer<br />
|<br />
|Number of Karma Points to award guild.<br />
|}<br />
<br />
<br />
Ex: <guild_award karma="10" /><br />
<br />
== Introduce ==<br />
<br />
This response operations introduce the player with the NPC. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Optional<br />
|string<br />
|Me<br />
|The character to introduce to the NPC.<br />
|}<br />
<br />
<br />
Ex: <introduce name="The Player" /><br />
<br />
== Money ==<br />
<br />
This response operations give money to the player. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|value<br />
|Mandatory<br />
|int,int,int,int or int<br />
|<br />
|The money to give. Either "Circles, octas, hexas, trias" or just "trias".<br />
|}<br />
<br />
<br />
Ex: <money value="1,2,3,4" /><br />
<money value="42" /><br />
<br />
== Narrate ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <narrate ... /><br />
<br />
== Narrate Public ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <narratepublic ... /><br />
<br />
== NPC Cmd ==<br />
<br />
This response operations send a command to the NPC Client. The command will trigger NPC responses. See [[Behaviors_and_Reactions#NPC_Cmd_Perception|NPC Cmd Perception]].<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|cmd<br />
|Mandatory<br />
|string<br />
|<br />
|Use format npccmd:global:<your cmd text> or npccmd:self:<your cmd text><br />
|}<br />
<br />
<br />
Ex: <npccmd cmd="npccmd:global:start_riot" /><br />
<npccmd cmd="npccmd:self:open_cage" /><br />
<br />
== Offer Reward ==<br />
<br />
This response operations offer items to the player. Either defined by ID or name. If ID is defined that will take precedence over name.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|id<br />
|Optional<br />
|integer<br />
|<br />
|The ID of the item stat of the item to offer. If id not defined name must be defined.<br />
|-<br />
|name<br />
|Optional<br />
|string<br />
|<br />
|The name of the item stat of the item to offer. If name not defined id must be defined.<br />
|}<br />
<br />
<br />
Ex: <offer><br />
<item id="10" /><br />
<item name="My Item State" /><br />
</offer><br />
<br />
== Respond ==<br />
<br />
This response operations respond with a text to the player. This is the same as the [[#Say|Say operation]].<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|text<br />
|Mandatory<br />
|string<br />
|<br />
|The chat message to respond with.<br />
|}<br />
<br />
<br />
Ex: <respond text="Hello" /><br />
<br />
== Run Script ==<br />
<br />
This response operations run a script. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|script<br />
|Mandatory<br />
|string<br />
|<br />
|The script<br />
|-<br />
|with<br />
|Optional<br />
|string<br />
|<br />
|Binding text.<br />
|}<br />
<br />
<br />
Ex: <run script="My Script" with="My Binding?" /><br />
<br />
== Respond Public ==<br />
<br />
This response operations respond with a text to the player. This is the same as the [[#Respond|Respond operation]] but the respond is public.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|text<br />
|Mandatory<br />
|string<br />
|<br />
|The chat message to respond with.<br />
|}<br />
<br />
<br />
Ex: <respondpublic text="Chat message going public" /><br />
<br />
== Say ==<br />
<br />
This response operations respond with a text to the player. This is the same as the [[#Respond|Respond operation]].<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|text<br />
|Mandatory<br />
|string<br />
|<br />
|The chat message to respond with.<br />
|}<br />
Ex: <say text="Hello" /><br />
<br />
== Set Variable ==<br />
<br />
This response operations set a character variable. Character variables are typically used from scripts.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the variable<br />
|-<br />
|value<br />
|Mandatory<br />
|string<br />
|<br />
|The value of the variable.<br />
|}<br />
<br />
<br />
Ex: <setvariable name="My Variable" value="My Value" /><br />
<br />
== Train ==<br />
<br />
This response operations start training for the player. A confirmation dialog is displayed at the client. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|skill<br />
|Mandatory<br />
|string<br />
|<br />
|Skill name<br />
|}<br />
<br />
<br />
Ex: <train skill="My Skill" /><br />
<br />
== Uncomplete Quest ==<br />
<br />
This response operations Un-complete a quest. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest_id<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <uncomplete quest_id="The Quest" error_msg="The Quest Uncomplete error message" /><br />
<br />
== Unset Variable ==<br />
<br />
This response operations Un-set a variable. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the variable.<br />
|}<br />
<br />
<br />
Ex: <unsetvariable name="My Variable" /><br />
<br />
== Verify Quest Assigned ==<br />
<br />
This response operations verify if a quest is assigned. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest<br />
|Mandatory<br />
|string<br />
|<br />
|Name of quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <verifyquestassigned quest="The Quest" error_msg="The Quest is not assigned" /><br />
<br />
== Verify Quest Completed ==<br />
<br />
This response operations verify if a quest is complete. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest<br />
|Mandatory<br />
|string<br />
|<br />
|Name of quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <verifyquestcompleted quest="The Quest" error_msg="The Quest is not completed" /><br />
<br />
== Verify Quest Not Assigned ==<br />
<br />
This response operations verify that a quest is not assigned. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest<br />
|Mandatory<br />
|string<br />
|<br />
|Name of quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <verifyquestnotassigned quest="The Quest" error_msg="The Quest is assigned" /><br />
<br />
[[Category:Engine documents]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operation&diff=20201Quest Script Operation2014-01-04T20:52:52Z<p>Magodra: moved Quest Script Operation to Quest Script Operations: Quest Script Operation</p>
<hr />
<div>#REDIRECT [[Quest Script Operations]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20200Quest Script Operations2014-01-04T20:52:52Z<p>Magodra: moved Quest Script Operation to Quest Script Operations: Quest Script Operation</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Custom_NPC_Dialogue&diff=20199Custom NPC Dialogue2014-01-04T20:47:59Z<p>Magodra: </p>
<hr />
<div>Custom NPC Dialogues are a subset of [[NPC Dialogues]] / [[Quest Script Operations]] that is include only functions that players can use to script NPCs. Actions that could be exploited to gain money or items is not included.<br />
<br />
Possible ways to exploit the quest syntax by players writing their own quests.<br />
<br />
The following commands need to be blocked from use, or severely limited.<br />
<br />
<br />
* Quest command - Give [quantity] [quality] [item]<br />
** They will be able to spawn any item in the the BD with qualities upto 300/300<br />
** Preventative action - block access as it is not needed by players.<br />
<br />
<br />
* Quest command - [un]complete [quest name] [step x].<br />
** This will allow players to modify any quest in the game. Exploit as players could do anything they wanted with restarting/modifying/completing any quest in the game.<br />
** Preventative action - Limit the command to ONLY work with the quest it is written in. This must not be a generic feature as official quests use this cross quest referencing a lot.<br />
<br />
<br />
* Quest command - [un]setvariable [variable name] [value]<br />
** This would allow players to modify any variable in the game, would cause massive problems.<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - doadmincmd [command]<br />
** This would let the player run GM commands, clearly a massive exploit<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest command - run script [script name] [script variables]<br />
** This would let players run any script<br />
** Preventative action - block player access as it is not needed by players.<br />
<br />
<br />
* Quest menu trigger - Player gives [npc name] [value] [items]<br />
** This would allow players to trick other players into giving almost any item to an npc and they would not be able to recover the item. A player could for example use "Player gives test guard 10000000 tria."<br />
** Preventative action - This style of trigger should be removed from use by players. OR it should be modified such that in player written quests all giving by players MUST be MANUAL only, not automatic using the menu clicks.<br />
<br />
<br />
* Quest dialog - referencing other NPCs in quests.<br />
** Players should not be allowed to reference offical settings NPCs in their quests, this is to avoid players making NPCs saying stupid things which are completely against settings.<br />
** Preventative action - The only NPC which can be scripted in the player written quest is the NPC which was hired by the player.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20198Quest Script Operations2014-01-04T16:07:31Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20197Quest Script Operations2014-01-04T16:07:23Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
Ex: Give 1 tria.Give 2 exp.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20196Quest Script Operations2014-01-04T16:06:27Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20195Quest Script Operations2014-01-04T16:06:17Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]]. Multiple commands can be defined separated with dots '.'.<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20194Quest Script Operations2014-01-04T16:02:09Z<p>Magodra: /* Give */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player. If multiple items are listed with or between an offer is made to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20193Quest Script Operations2014-01-04T16:00:36Z<p>Magodra: /* Give */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give <value> tria|hexa|ocata|circle|exp|faction<br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
Give items or money to the player.<br />
<br />
Ex: Give 1 Ring of Familiar.<br />
Give 3 tria.<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20192Quest Script Operations2014-01-04T15:57:38Z<p>Magodra: /* Give */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give tria|hexa|ocata|circle|exp|faction <value><br />
Give <item> or <item><br />
Give [<count>] [<quality>] <item><br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20191Quest Script Operations2014-01-04T15:00:32Z<p>Magodra: /* NPC tell (:) */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell ==<br />
<br />
Syntax: <npc>:<Message><br />
<br />
NPC respone to a player with a message.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give tria|hexa|ocata|circle|exp|faction <value><br />
Give <item> or <item><br />
Give <item> <count> <quality><br />
<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20190Quest Script Operations2014-01-04T14:59:57Z<p>Magodra: /* Player tell(P:) */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell ==<br />
<br />
Syntax: P:<Message><br />
<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give tria|hexa|ocata|circle|exp|faction <value><br />
Give <item> or <item><br />
Give <item> <count> <quality><br />
<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20189Quest Script Operations2014-01-04T14:59:14Z<p>Magodra: /* New substep ... */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give tria|hexa|ocata|circle|exp|faction <value><br />
Give <item> or <item><br />
Give <item> <count> <quality><br />
<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20188Quest Script Operations2014-01-04T14:59:07Z<p>Magodra: /* Menu */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
Syntax: Menu:<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give tria|hexa|ocata|circle|exp|faction <value><br />
Give <item> or <item><br />
Give <item> <count> <quality><br />
<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20187Quest Script Operations2014-01-04T14:58:37Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest name><br />
<br />
=== Complete ===<br />
<br />
Syntax: Complete <quest name><br />
<br />
=== DoAdminCmd ===<br />
<br />
Syntax: DoAdminCmd <Admin command><br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
Syntax: Give tria|hexa|ocata|circle|exp|faction <value><br />
Give <item> or <item><br />
Give <item> <count> <quality><br />
<br />
<br />
=== Introduce ===<br />
<br />
Syntax: <br />
<br />
=== NoRepeat===<br />
<br />
Syntax: <br />
<br />
=== Require ===<br />
<br />
Syntax: <br />
<br />
=== Run script ===<br />
<br />
Syntax: <br />
<br />
=== SetVariable ===<br />
<br />
Syntax: <br />
<br />
=== Uncomplete ===<br />
<br />
Syntax: Uncomplete <quest name><br />
<br />
=== UnsetVariable ===<br />
<br />
Syntax:</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20186Quest Script Operations2014-01-04T14:53:29Z<p>Magodra: /* Assign Quest */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
Syntax: Assign Quest <quest><br />
<br />
=== Complete ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
=== Introduce ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== SetVariable ===<br />
<br />
=== Uncomplete ===<br />
<br />
=== UnsetVariable ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20185Quest Script Operations2014-01-04T14:52:54Z<p>Magodra: /* Fire Event (Not completed) */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
=== Complete ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== FireEvent ===<br />
(Note: Not completed.)<br />
<br />
Syntax: FireEvent <br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
=== Introduce ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== SetVariable ===<br />
<br />
=== Uncomplete ===<br />
<br />
=== UnsetVariable ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20184Quest Script Operations2014-01-04T14:51:34Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
=== Complete ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== Fire Event (Not completed) ===<br />
<br />
Syntax: FireEvent <br />
<br />
(Note no space)<br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Give ===<br />
<br />
=== Introduce ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== SetVariable ===<br />
<br />
=== Uncomplete ===<br />
<br />
=== UnsetVariable ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20183Quest Script Operations2014-01-04T14:49:14Z<p>Magodra: /* Fire Event */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
=== Fire Event (Not completed) ===<br />
<br />
Syntax: FireEvent <br />
<br />
(Note no space)<br />
<br />
The fire event has no corresponding Response Operation.<br />
<br />
=== Complete ===<br />
<br />
=== Uncomplete ===<br />
<br />
<br />
=== setvariable ===<br />
<br />
=== unsetvariable ===<br />
<br />
=== Give ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== Introduce ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20182Quest Script Operations2014-01-04T14:46:03Z<p>Magodra: /* Fire Event */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
=== Fire Event ===<br />
<br />
Syntax: FireEvent <br />
<br />
(Note no space)<br />
<br />
=== Complete ===<br />
<br />
=== Uncomplete ===<br />
<br />
<br />
=== setvariable ===<br />
<br />
=== unsetvariable ===<br />
<br />
=== Give ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== Introduce ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Response_Operation&diff=20181Response Operation2014-01-04T14:43:01Z<p>Magodra: /* Response Operations */</p>
<hr />
<div><br />
= Response Operations =<br />
<br />
Response operations are used to script response scripts as part of [[NPC Dialogues]]. They are also build internally in the server from the Quest system through [[Quest Script Operation|Quest Script Operations]].<br />
== Action ==<br />
<br />
This response operations cause an action by the NPC. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|Mandatory<br />
|string<br />
|<br />
|Name of animation<br />
|-<br />
|text<br />
|Optional<br />
|string<br />
|<br />
|Action command.<br />
|}<br />
<br />
<br />
Ex: <action anim="The anim" text="The action" /><br />
<br />
== Action My ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <actionmy ... /><br />
<br />
== Action My Public ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <actionmypublic ... /><br />
<br />
== Action Public ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <actionpublic ... /><br />
<br />
== Assign Quest ==<br />
<br />
This response operations assign a new quest to the player. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|q1<br />
|Mandatory<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q2<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q2<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q3<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q4<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|q5<br />
|Optional<br />
|string<br />
|<br />
|Name of the quest<br />
|-<br />
|timeout_msg<br />
|Optional<br />
|string<br />
|<br />
|The timeout message.<br />
|}<br />
<br />
<br />
Ex: <assign q1="The Quest" q2="The Other Quest" timeout_msg="The Quest timeout message" /><br />
<br />
== Complete Quest ==<br />
<br />
This response operations complete a quest. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest_id<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <complete quest_id="The Quest" error_msg="The Quest Complete error message" /><br />
<br />
== Do Admin Command ==<br />
<br />
This response operations run an admin command. In the command string the key words "targetchar" and "sourcenpc" is replaced with target and the NPC talking.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|command<br />
|Mandatory<br />
|string<br />
|<br />
|The admin command to run.<br />
|}<br />
<br />
<br />
Ex: <doadmincmd command="/debugnpc sourcenpc 5" /><br />
<br />
== Faction ==<br />
<br />
This response operations adjust the faction. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Mandatory<br />
|string<br />
|<br />
|Name of the faction.<br />
|-<br />
|value<br />
|Mandatory<br />
|integer<br />
|<br />
|The faction value.<br />
|}<br />
<br />
<br />
Ex: <faction name="My Faction" value="5" /><br />
<br />
== Give Item ==<br />
<br />
This response operations give items to the player. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|item<br />
|Mandatory<br />
|string or integer<br />
|<br />
|The name of the item stat or the id of the item stat.<br />
|-<br />
|count<br />
|Optional<br />
|integer<br />
|1<br />
|The number of items to give.<br />
|-<br />
|quality<br />
|Optional<br />
|integer<br />
|0<br />
|The quality of the new item.<br />
|}<br />
<br />
<br />
Ex: <give item="The Item" count="2" quality="50" /><br />
<br />
== Guild Award ==<br />
<br />
This response operations award a guild Karma Points. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|karma<br />
|Mandatory<br />
|integer<br />
|<br />
|Number of Karma Points to award guild.<br />
|}<br />
<br />
<br />
Ex: <guild_award karma="10" /><br />
<br />
== Introduce ==<br />
<br />
This response operations introduce the player with the NPC. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Optional<br />
|string<br />
|Me<br />
|The character to introduce to the NPC.<br />
|}<br />
<br />
<br />
Ex: <introduce name="The Player" /><br />
<br />
== Money ==<br />
<br />
This response operations give money to the player. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|value<br />
|Mandatory<br />
|int,int,int,int or int<br />
|<br />
|The money to give. Either "Circles, octas, hexas, trias" or just "trias".<br />
|}<br />
<br />
<br />
Ex: <money value="1,2,3,4" /><br />
<money value="42" /><br />
<br />
== Narrate ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <narrate ... /><br />
<br />
== Narrate Public ==<br />
<br />
This response operations . <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<br />
Ex: <narratepublic ... /><br />
<br />
== NPC Cmd ==<br />
<br />
This response operations send a command to the NPC Client. The command will trigger NPC responses. See [[Behaviors_and_Reactions#NPC_Cmd_Perception|NPC Cmd Perception]].<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|cmd<br />
|Mandatory<br />
|string<br />
|<br />
|Use format npccmd:global:<your cmd text> or npccmd:self:<your cmd text><br />
|}<br />
<br />
<br />
Ex: <npccmd cmd="npccmd:global:start_riot" /><br />
<npccmd cmd="npccmd:self:open_cage" /><br />
<br />
== Offer Reward ==<br />
<br />
This response operations offer items to the player. Either defined by ID or name. If ID is defined that will take precedence over name.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|id<br />
|Optional<br />
|integer<br />
|<br />
|The ID of the item stat of the item to offer. If id not defined name must be defined.<br />
|-<br />
|name<br />
|Optional<br />
|string<br />
|<br />
|The name of the item stat of the item to offer. If name not defined id must be defined.<br />
|}<br />
<br />
<br />
Ex: <offer><br />
<item id="10" /><br />
<item name="My Item State" /><br />
</offer><br />
<br />
== Respond ==<br />
<br />
This response operations respond with a text to the player. This is the same as the [[#Say|Say operation]].<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|text<br />
|Mandatory<br />
|string<br />
|<br />
|The chat message to respond with.<br />
|}<br />
<br />
<br />
Ex: <respond text="Hello" /><br />
<br />
== Run Script ==<br />
<br />
This response operations run a script. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|script<br />
|Mandatory<br />
|string<br />
|<br />
|The script<br />
|-<br />
|with<br />
|Optional<br />
|string<br />
|<br />
|Binding text.<br />
|}<br />
<br />
<br />
Ex: <run script="My Script" with="My Binding?" /><br />
<br />
== Respond Public ==<br />
<br />
This response operations respond with a text to the player. This is the same as the [[#Respond|Respond operation]] but the respond is public.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|text<br />
|Mandatory<br />
|string<br />
|<br />
|The chat message to respond with.<br />
|}<br />
<br />
<br />
Ex: <respondpublic text="Chat message going public" /><br />
<br />
== Say ==<br />
<br />
This response operations respond with a text to the player. This is the same as the [[#Respond|Respond operation]].<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|text<br />
|Mandatory<br />
|string<br />
|<br />
|The chat message to respond with.<br />
|}<br />
Ex: <say text="Hello" /><br />
<br />
== Set Variable ==<br />
<br />
This response operations set a character variable. Character variables are typically used from scripts.<br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the variable<br />
|-<br />
|value<br />
|Mandatory<br />
|string<br />
|<br />
|The value of the variable.<br />
|}<br />
<br />
<br />
Ex: <setvariable name="My Variable" value="My Value" /><br />
<br />
== Train ==<br />
<br />
This response operations start training for the player. A confirmation dialog is displayed at the client. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|skill<br />
|Mandatory<br />
|string<br />
|<br />
|Skill name<br />
|}<br />
<br />
<br />
Ex: <train skill="My Skill" /><br />
<br />
== Uncomplete Quest ==<br />
<br />
This response operations Un-complete a quest. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest_id<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <uncomplete quest_id="The Quest" error_msg="The Quest Uncomplete error message" /><br />
<br />
== Unset Variable ==<br />
<br />
This response operations Un-set a variable. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|Mandatory<br />
|string<br />
|<br />
|The name of the variable.<br />
|}<br />
<br />
<br />
Ex: <unsetvariable name="My Variable" /><br />
<br />
== Verify Quest Assigned ==<br />
<br />
This response operations verify if a quest is assigned. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest<br />
|Mandatory<br />
|string<br />
|<br />
|Name of quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <verifyquestassigned quest="The Quest" error_msg="The Quest is not assigned" /><br />
<br />
== Verify Quest Completed ==<br />
<br />
This response operations verify if a quest is complete. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest<br />
|Mandatory<br />
|string<br />
|<br />
|Name of quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <verifyquestcompleted quest="The Quest" error_msg="The Quest is not completed" /><br />
<br />
== Verify Quest Not Assigned ==<br />
<br />
This response operations verify that a quest is not assigned. <br />
<br />
{|<br />
!Attribute<br />
!Required<br />
!Values/Type<br />
!Default<br />
!Description<br />
|-<br />
|quest<br />
|Mandatory<br />
|string<br />
|<br />
|Name of quest.<br />
|-<br />
|error_msg<br />
|Optional<br />
|string<br />
|<br />
|Error message.<br />
|}<br />
<br />
<br />
Ex: <verifyquestnotassigned quest="The Quest" error_msg="The Quest is assigned" /><br />
<br />
[[Category:Engine documents]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20180Quest Script Operations2014-01-04T14:37:35Z<p>Magodra: /* Commands */</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
Commands build [[Response Operation|Response Operations]].<br />
<br />
=== Assign Quest ===<br />
<br />
=== Fire Event ===<br />
<br />
=== Complete ===<br />
<br />
=== Uncomplete ===<br />
<br />
<br />
=== setvariable ===<br />
<br />
=== unsetvariable ===<br />
<br />
=== Give ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== Introduce ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Quest_Script_Operations&diff=20179Quest Script Operations2014-01-04T14:35:47Z<p>Magodra: Created page with "= Quest Script Operations = Quest script operations are used to script Quests. == Menu == == New substep ... == Syntax: ... [NoRepeat] == NPC tell (<npc>:) == NPC respone ..."</p>
<hr />
<div>= Quest Script Operations =<br />
Quest script operations are used to script Quests.<br />
<br />
== Menu ==<br />
<br />
== New substep ... ==<br />
<br />
Syntax: ... [NoRepeat]<br />
<br />
== NPC tell (<npc>:) ==<br />
NPC respone to a player.<br />
<br />
== Player tell(P:) ==<br />
Player tell npc.<br />
<br />
== Player ==<br />
Player action.<br />
<br />
== QuestNote ==<br />
<br />
<br />
== Commands ==<br />
<br />
=== Assign Quest ===<br />
<br />
=== Fire Event ===<br />
<br />
=== Complete ===<br />
<br />
=== Uncomplete ===<br />
<br />
<br />
=== setvariable ===<br />
<br />
=== unsetvariable ===<br />
<br />
=== Give ===<br />
<br />
=== NoRepeat===<br />
<br />
=== Require ===<br />
<br />
=== Run script ===<br />
<br />
=== DoAdminCmd ===<br />
<br />
=== Introduce ===</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Behavior_Operations&diff=20176Behavior Operations2014-01-01T19:16:08Z<p>Magodra: /* Locate Operation */</p>
<hr />
<div>A “Behavior” in NPCClient is a script defined in [[NPC_Behavior_Data_Structures#npcbehave.xml|npcbehave.xml]] to run to make the npc behave a certain way. It is almost like<br />
a state, for AI designers used to state machine npcs. Example behaviors might include “guard<br />
patrol”, “wander in forest”, “fight attackers”, “smith an item”. Before we talk about how<br />
everything fits together we will go over what is possible in npcclient with these detailed behavior<br />
scripts. The following is a list and reference description of each behavior script operation or<br />
command you can use. They are put together in sequences called beaviors as will be described later in [[Behaviors_and_Reactions]].<br />
<br />
<br />
== Assess Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|physical<br />
|string<br />
|<br />
|The prefix for the physical perception.<br />
|-<br />
|magical<br />
|string<br />
|<br />
|The prefix for the magical perception.<br />
|-<br />
|overall<br />
|string<br />
|<br />
|The perfix for the overall perception.<br />
|}<br />
<br />
Each of the physical, magical, or overall will be assessed as; "extremely weaker", "much weaker", "weaker", "equal", "stronger", "much stronger" or "extremely stronger". <br />
<br />
<br />
Ex: <assess overall="$target overall" /><br />
<br />
Typical reaction to catch the response to this would be as shown in the example below. $target is used here to make sure the correct assessment is matched to the same target. A npc will<br />
not react if the target has changed before the response is received.<br />
<br />
Ex: <react event="assess equal" type="$target overall" .../><br />
<react event="assess weaker" type="$target overall" .../><br />
<br />
== Auto Memorize Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|types<br />
|string<br />
|<br />
|Comma separated list of types. "all", can be used to memorize everything to all.<br />
|-<br />
|enable<br />
|bool<br />
|true<br />
|Enables or disables the types.<br />
|-<br />
|}<br />
<br />
Auto memorize is a way to turn on and off memorizing of perception. This will be memorize without actually needing to react to thees. Related to the [[Behavior_Operations#Share_Memories_Operation|Share Memories Operation]].<br />
<br />
Ex: <auto_memorize types="all" /><br />
<auto_memorize types="Hunting Ground,Marked" /><br />
<auto_memorize types="Marked" enable="false" /><br />
<br />
You can use a reaction without a behavior lists to enable the NPC to receive perceptions to be memorized if enabled.<br />
<br />
Ex: <react type="location sensed" /><br />
<br />
== Build Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|pickupable<br />
|boolean<br />
|false<br />
|If false the building deployed will not be pickupable by the players<br />
|}<br />
<br />
Build a building as specified bye the NPC's current held building spot as set by the [[Tribe Scripting]] [[Tribe_Scripting#LocateBuildingSpot|locateBuildingSpot]] function. <br />
<br />
<br />
Ex: <build /><br />
<br />
== Busy Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
<br />
Mark a NPC as busy. This will cancle the [[Behavior_Operations#Idle_Operation|Idle Operation]]<br />
<br />
<br />
Ex: <busy /><br />
<br />
== Cast Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|spell<br />
|string<br />
|<br />
|The name of the spell to cast.<br />
|-<br />
|k<br />
|float<br />
|1.0<br />
|The kFactor to use when casting the spell.<br />
|}<br />
<br />
Cast a spell on the current selected target.<br />
<br />
Ex: <cast spell="Flame Strike" k="3.0" /><br />
<br />
== Change Brain Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|brain<br />
|string<br />
|<br />
|The name of the brain to load.<br />
|-<br />
|brain<br />
|reload<br />
|<br />
|Reload the standard NPC the brain stored in the sc_npc_definition table.<br />
|-<br />
|}<br />
<br />
Change the brain of the current selected target.<br />
<br />
Ex: <change_brain brain="Charmed" /><br />
<br />
== Chase Operation ==<br />
(Net load: 3, CPU Load 3)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to use for the chase.<br />
|-<br />
|adaptiv_vel_script<br />
|string<br />
|<br />
|A [[NPCClient math script]] used to adjust the adaptivVelocityScale. Additional variables defined for this script is "Distance" to the target of the chase and "AdaptivVelScale" that is the value used to adjust velocity. 1.1 will increase the velocity by 10%.<br />
|-<br />
|type<br />
|nearest_actor,nearest_npc,nearest_player,owner,target<br />
|<br />
|nearest_* is the nearest entity of that type. target is current target.<br />
|-<br />
|range<br />
|float<br />
|2.0<br />
|The range to search for target of the chase.<br />
|-<br />
|chase_range<br />
|float<br />
| -1<br />
|The range at where the chase should give up and issue a "<target> out of chase" perception. -1 is default to disable the max range check.<br />
|-<br />
|offset<br />
|float<br />
|0.5<br />
|The distance to stop before the target of the chase. [[NPC Variables]] will be replaced. Expressions will be resolved. See [[Behavior_Offset|Offset]] for more details.<br />
|-<br />
|offset_angle<br />
|float<br />
|0.0<br />
|Size of the arc used to distribute the chase when approaching the target. The angle is in degrees.<br />
|-<br />
|vel<br />
|float,$WALK,$RUN<br />
|Default is to use the velocity from the behavior.<br />
|The velocity to use when chasing.<br />
|-<br />
|ang_vel<br />
|float<br />
|<br />
|0 is to use the default from the behavior.<br />
|-<br />
|collision<br />
|string<br />
|collision<br />
|The name of the perception to be used when a collision perception is to be fired.<br />
|-<br />
|out_of_bounds<br />
|string<br />
|out of bounds<br />
|The name of the perception to be used when a out of bounds perception is to be fired.<br />
|-<br />
|in_bounds<br />
|string<br />
|in bounds<br />
|The name of the perception to be used when a in bound perception is to be fired.<br />
|}<br />
<br />
<br />
<br />
Chasing a player is one example where both turning and moving at the same time are required to<br />
give a realistic effect to the behavior. We have <move> and <rotate> but this one does them<br />
together and intelligently to follow a targeted player or entity. Normally, this will be used to get<br />
npc’s to chase after players if players run away during a fight.<br />
<br />
Ex: <chase type="enemy" anim="walk" range=”2” /><br />
<br />
In this example, the npc will play the animation called “walk” while moving and turning as<br />
appropriate to reduce his range to his most hated enemy. Of course, he is limited by his speed and<br />
if the player can run faster than he can chase, he will never catch the player. An "<target> out of chase" perception<br />
will be fired in this case.<br />
<br />
The “type” attribute of the operation can be either “enemy” as shown here, “owner” to follow the<br />
NPC’s owner around, or “nearest” to chase after the nearest player at the time the operation was<br />
initiated. This operation will continue until interrupted by another behavior or until the distance to<br />
the target from the npc is less than the range specified. (2 is the default if no range is specified.)<br />
This operation sends DR messages whenever it turns or changes course, plus the DR messages to<br />
start the forward motion and animation, and to stop them. The CPU load is somewhat heavy<br />
because CD must be performed as the npc is chasing, since his path is not predetermined.<br />
<br />
== Circle Operation ==<br />
(Net load: 3, CPU Load: 2)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to use for the operation.<br />
|-<br />
|radius<br />
|float<br />
|Mandatory, no default value<br />
|Radius to move NPC around with.<br />
|-<br />
|angle<br />
|float<br />
|2PI<br />
|The angle to move. Calculated if 0 and duration not 0.<br />
|-<br />
|duration<br />
|float<br />
|0<br />
|The duration to move in circle. Calculated if 0. <br />
|-<br />
|ang_vel<br />
|float<br />
|<br />
|The angular velocity to use when moving in the circle. Calculated if 0.<br />
|}<br />
<br />
<br />
<br />
Moving the NPC around in a circle. The following example will move the npc around using the velocity defined in the behavior in one complete circle in 10 sec.<br />
<br />
Ex: <circle anim="walk" radius=”2” duration="10" /><br />
<br />
== Control Operation ==<br />
(Net load: 3, CPU Load: 2)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
<br />
<br />
<br />
Take control of an player an move with the player.<br />
<br />
Ex: <control /><br />
<br />
== Copy_Locate Operation ==<br />
(Net load: 0, CPU Load: 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|source<br />
|string<br />
|Mandatory, no default value<br />
|The source locate to copy from.<br />
|-<br />
|destination<br />
|float<br />
|Mandatory, no default value<br />
|The destination locate to copy to.<br />
|}<br />
<br />
<br />
<br />
Copy one locate from source to destination. Built in function like Wander and Navigate use the Active locate.<br />
<br />
Ex: <locate obj="some thing" destination="SpecialPlace" /><br />
<copy_locate source="SpecialPlace" destination="Active" /><br />
<br />
== Debug Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|level<br />
|int<br />
|Mandatory<br />
|The level of debug to turn on for current NPC.<br />
|-<br />
|exclusive<br />
|string<br />
|<br />
|Will set on exclusive logging for this NPC.<br />
|}<br />
<br />
Turn on and of debug printouts on the server console. Used for debuging of script operations. Level 1-4 Only the biggest events, 5-9 Medium number of events, 10-15 and more is maximum output.<br />
<br />
Ex: <debug level=”2” /><br />
<br />
== Dequip Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|slot<br />
|string<br />
|Mandatory<br />
|The slot to dequip an move back into inventory.<br />
|}<br />
<br />
Dequip an item held by the NPC in the given slot.<br />
<br />
Ex: <dequip slot="righthand" /><br />
<br />
== Drop Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|slot<br />
|string<br />
|Mandatory<br />
|The slot from which the item is to be dropped.<br />
|}<br />
<br />
This operation allows an NPC to drop an item he has in inventory on the ground.<br />
<br />
Ex: <drop slot="lefthand" /><br />
<br />
== Eat Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|resource<br />
|string,tribe:wealth<br />
|Mandatory<br />
|The resource to reward the tribe when eating.<br />
|}<br />
<br />
Simple simulation that the tribe would gain things like flesh from eating at a dead entity withing a range of 1.0. The tribe wealth resource would be read from the wealt_resource_name field in the [[NPC_Behavior_Data_Structures#tribes#tribes|tribes]] table.<br />
<br />
Ex: <eat resource="tribe:wealth" /><br />
<eat resource="Flesh" /><br />
<br />
== Emote Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|cmd<br />
|string<br />
|<br />
|The emote cmd to be used as defined in the emote.xml file. Including leading /.<br />
|}<br />
This operation allows an NPC to do an emotion.<br />
<br />
Ex: <emote cmd="/greet" /><br />
<br />
== Equip Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|item<br />
|string<br />
|Mandatory<br />
|The name of the item to equip<br />
|-<br />
|slot<br />
|string<br />
|Mandatory<br />
|The sloot to dquip the item in<br />
|-<br />
|count<br />
|int<br />
|1<br />
|The number of items to equip. Will be forced to at least 1.<br />
|}<br />
<br />
Equip one item from inventory into the given slot.<br />
<br />
Ex: <equip item="Sword" slot="righthand" count="1" /><br />
<br />
== Hate List Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|delta<br />
|float<br />
|<br />
|Add delta to hate list.<br />
|-<br />
|absolute<br />
|float<br />
|<br />
|Set the hate value.<br />
|-<br />
|max<br />
|float<br />
|<br />
|Hate should have a max value<br />
|-<br />
|min<br />
|float<br />
|<br />
|Hate should have a min value<br />
|-<br />
|perception<br />
|bool<br />
|false<br />
|Use perception instead of target to find target. <br />
|}<br />
<br />
Adjust the hate list for an npc. The current target or perception target is the target entry for the adjustment.<br />
<br />
Ex: <hate_list delta="0.5" max="10.0" /><br />
<br />
Ex: <locate obj="perception" /><br />
<hate_list absolute="5.0" /><br />
<br />
Is equvivalent with:<br />
<br />
<hate_list perception="yes" absolute="5.0" /><br />
<br />
== Idle Operation ==<br />
(Net load: 1, CPU Load 1)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
<br />
Mark a NPC as idle. This operation cancle the [[Behavior_Operations#Busy_Operation|Busy operation]].<br />
<br />
<br />
Ex: <idle /><br />
<br />
== Invisible Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No parameters.<br />
<br />
This operation makes the NPC invisible through the toggle visibility command. See [[Behavior_Operations#Visible_Operation|Visible Operation]].<br />
<br />
Ex: <invisible /><br />
<br />
== Locate Operation ==<br />
(Net load: 0, CPU Load 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|obj<br />
|See table below.<br />
|Mandatory<br />
|The object to locate. [[NPC Variables]] will be replaced.<br />
|-<br />
|failure<br />
|string<br />
|<br />
|A perception to fire if fails to locate the given obj.<br />
|-<br />
|static<br />
|boolean<br />
|false<br />
|For location the search could be made static. Se description for more details.<br />
|-<br />
|range<br />
|float<br />
| -1<br />
|The maximum range to locate within. -1 represents infinite.<br />
|-<br />
|random<br />
|boolean<br />
|false<br />
|If true a random return within the radius will be made. Otherwise the nearest entry will be returned.<br />
|-<br />
|outside_region<br />
|boolean<br />
|false<br />
|Set this to true if the locate operation should consider entities outside region as well if a region is defined. [[NPC Variables]] will be replaced.<br />
|-<br />
|invisible<br />
|boolean<br />
|false<br />
|Set this to true if the locate operation should consider invisible objects<br />
|-<br />
|invincible<br />
|boolean<br />
|false<br />
|Set this to true if the locate operation should consider invincible objects.<br />
|-<br />
|destination<br />
|string<br />
|Active<br />
|Set the destination [[NPC locate location]]. [[NPC Variables]] will be replaced.<br />
|}<br />
<br />
Obj can be one of the following:<br />
{|<br />
!obj<br />
!Description<br />
|-<br />
|<string><br />
|Locate a location. This is the default if none of the following obj types is matched.<br />
|-<br />
|actor<br />
|Located nearest actor<br />
|-<br />
|building_spot<br />
|Locate a building spot from the npc's building spot.<br />
|-<br />
|dead<br />
|Nearest dead actor<br />
|-<br />
|entity:name:<name><br />
|Entity with given name<br />
|-<br />
|entity:pid:<pid><br />
|Entity with given pid<br />
|-<br />
|friend<br />
|Nearest visible friend (NPC)<br />
|-<br />
|local_region<br />
|Locate region in current sector.<br />
|-<br />
|ownbuffer<br />
|Locate the own buffer.<br />
|-<br />
|owner<br />
|Locate the owner, if this NPC is owned (Pets and stuff)<br />
|-<br />
|perception<br />
|The location of the last received perception.<br />
|-<br />
|player<br />
|Nearest player<br />
|-<br />
|point<br />
|Random point<br />
|-<br />
|region<br />
|Locate a random point within the region of the NPC.<br />
|-<br />
|self<br />
|Locate your self<br />
|-<br />
|spawn<br />
|Spawn location of the npc.<br />
|-<br />
|target<br />
|Locate a target. The target will be the most hated from the NPC [[hate list]].<br />
|-<br />
|tribe:home<br />
|Locate the npcs [[Tribes|tribe]] home place.<br />
|-<br />
|tribe:memory:string<br />
|Locate something from the [[Tribes]] memory. See the [[Behavior_Operations#ShareMemories_Operation|ShareMemories]] and [[Behavior_Operations#Memorize_Operation|Memorize]] operation.<br />
|-<br />
|tribe:resource<br />
|Locate a resource location from the memory of the [[Tribes|tribe]].<br />
|-<br />
|tribe:target<br />
|Locate the most hated target for this tribe. The target will be the most hated from all the NPCs [[hate list]] in the tribe.<br />
|-<br />
|waypoint<br />
|Will locate a waypoint.<br />
|-<br />
|waypoint:group:string<br />
|Locate a waypoint from a given group<br />
|-<br />
|waypoint:name:string<br />
|Locate a waypoint by name.<br />
|}<br />
<br />
This operation is one of the more flexible and crucial operations in npc scripting. It allows the<br />
scripter to have his npc “find” a certain thing or type of thing, and remember that location for other<br />
scripting commands later such as turning, moving or attacking. The operation will store the position<br />
found in the NPCs as active postion and calcualte the neares waypoint and store that in the active_waypoint.<br />
For location it is possible to make the first search a static search. So that the first time the npc<br />
do this operation it could search for a "Baker" location. The next time the operation is used it will<br />
use the results of the first time even if there might be Bakers closer at that time.<br />
<br />
Ex: <locate obj="perception" /><br />
<locate obj="target" /><br />
<locate obj="furnace" range="50" /><br />
<locate obj="waypoint" failure="no waypoint found" /><br />
<br />
Example 1 finds the last perception received by the current npc and sets the active target location to<br />
the location of that perception. This allows npcs who receive “Talk” perceptions to turn to face the<br />
person talking to them. It allows npcs who have a spell cast on them to turn to face the caster, and<br />
so on.<br />
<br />
Example 2 finds the location of the currently active “enemy” of the NPC, which is the entity with<br />
the highest score on the NPC’s [[hate list]], and sets that location as the active target location for other<br />
operations. This allows NPCs to turn to face the person they are attacking, chase attackers who are<br />
retreating, etc.<br />
<br />
Example 3 uses predefined lists of named location types to find the closest one to the npc and sets<br />
the active target location to the coordinates specified there. This is the most subtle of the 3, and in<br />
some ways the most powerful so it deserves more discussion. Consider the following pictures:<br />
<br />
http://www.planeshift.it/download/docs/npc_pic1.png<br />
<br />
Here we have two blacksmith shops with similar items but different layouts. They might be side by<br />
side or they might be in entirely different cities. LocTypes specify a list of Anvil locations, or a list<br />
of Furnace locations, as marked by the stars on these pictures. When Example 3 says to locate the<br />
nearest furnace, an NPC in smithy #1 will find his furnace while the NPC in smithy #2 will find his<br />
own furnace. They will be able to share one script for moving between these points and acting like<br />
a real blacksmith in their own location, even though they are in totally different smithy shops.<br />
<br />
This will become even more important when we implement player housing and player shops. It<br />
will be possible with the scripts we have already today for a player to build the blacksmith shop of<br />
his own design and for him to hire an npc smith to come work in that shop. The Smith NPC he<br />
hired will be able to “know” how to get around the player’s shop magically.<br />
<br />
Something intended to be supported here but not actually implemented yet was the ability to locate<br />
named objects or entities as well, so an NPC could locate a sword someone dropped on the ground<br />
and things like this. Better integration with the entity system and perhaps integration with data<br />
from the maps themselves rather than externally generated lists of points could make this even more<br />
powerful.<br />
<br />
== Loop Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|iterations<br />
|int<br />
|0<br />
|Number of iterations to do in this loop. No iterations attribute or a value of -1 is loop forever.<br />
|}<br />
<br />
This operation allows you to loop a section of your script a certain number of times. This is mostly<br />
useful for city npcs such as smiths and tavern barkeeps. Behaviors in general will loop if not<br />
replaced by another behavior, but if you want subloops within the script, this is an easy way to do it.<br />
<br />
Ex:<br />
<loop iterations="20"><br />
<locate obj="fire" range="10" /><br />
<navigate anim="walk" /><br />
<wait anim="stand" duration="30" /><br />
<locate obj="anvil" range="10" /><br />
<navigate anim="walk" /><br />
<wait anim="hammer" duration="20" /><br />
</loop><br />
<br />
In this example, the blacksmith is scripted to walk back and forth between his fire and his anvil 20<br />
times before moving on to the next operation in his script to act like a blacksmith.<br />
<br />
This operation does not affect the network at all and does not have CPU overhead.<br />
<br />
== Melee Operation ==<br />
(Net load: 1, CPU Load: 2)<br />
<br />
{|<br />
!Parameter<br />
!Description<br />
|-<br />
|seek_range<br />
|float<br />
|0.0<br />
|The range to search for new targets in melee<br />
|-<br />
|melee_range<br />
|float[0.5-3.0] <br />
|3.0<br />
|The range where melee can be done. Max 3.0 to prevent npc/server conflicts.<br />
|-<br />
|stance<br />
|string<br />
|normal<br />
|The stance to use when attacking. [[NPC Variables]] will be replaced. <br />
|-<br />
|tribe<br />
|boolean<br />
|false<br />
|When set to true the tribe [[hate list]] will be used to select target. If true and NPC not member of a tribe the NPC [[hate list]] will be used as a fall back. [[NPC Variables]] will be replaced.<br />
|-<br />
|outside_region<br />
|boolean<br />
|false<br />
|Set to true to fight even outside region if a region is defined. [[NPC Variables]] will be replaced.<br />
|-<br />
|invisible<br />
|boolean<br />
|false<br />
|Will melee operation fight invisible entities<br />
|-<br />
|invincible<br />
|boolean<br />
|false<br />
|Will melee operation fight invincible entities.<br />
|}<br />
<br />
The <melee> operation handles starting and ending fights for the NPC. It finds the most hated<br />
enemy in range and tells the server to attack him. If there is no enemy in range, it finds the nearest<br />
enemy that it does hate and prepares to chase him.<br />
<br />
Ex: <melee seek_range="10" melee_range="3" /><br />
<br />
The “melee_range” attribute specifies how far away the enemies can be while still fighting without<br />
the npc needing to move. 3 meters is the maximum of how far away a player can be to hit the npc<br />
also, so in most cases this is a good value. The “seek_range” specifies how far around himself the<br />
npc should look for other enemies if none are found within the melee_range. If there are no<br />
enemies within the seek_range, the npc starts to calm down and his current behavior (making his<br />
‘melee’ operation active) is lowered in priority. If an enemy is found within the seek_range, the<br />
NPC’s active enemy is set to this found person so the <chase type=”enemy”> operation can run<br />
after him.<br />
<br />
This operation’s only network load is informing the server of its melee target and attack mode, and<br />
switching these occasionally as people die, etc. The CPU load is in periodically (2x per second)<br />
checking the [[hate list]] for the NPC to make sure the most hated person is being fought. If no one on<br />
the [[hate list]] is within the melee range, a more expensive operation is done to find any hated people<br />
within the seek_range, but this operation isn’t performed very often.<br />
<br />
See the NPC [[hate list]] for further details about the [[hate list]].<br />
<br />
== Memorize Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No Parameters.<br />
<br />
This is an operation that only will have effect for tribe members. The NPC will memorize the current perception as a private memory.<br />
See the [[Behavior_Operations#ShareMemories_Operation|ShareMemories Operation]] for how to make the memories known to other members of the tribe.<br />
<br />
Ex: <memorize /><br />
<br />
== Move Operation ==<br />
(Net load: 0, CPU Load: 5) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to use when moving.<br />
|-<br />
|duration<br />
|float<br />
|0.0<br />
|The duration this move should have. The default is probably no good. <br />
|-<br />
|vel<br />
|float,$WALK,$RUN<br />
|Default is to use the velocity from the behavior.<br />
|The velocity to use when moving.<br />
|-<br />
|ang_vel<br />
|float<br />
|0.0<br />
|By defining a ang_vel the movement will be much like the [[Behavior_Operations#Circle_Operation|Circle Operation]].<br />
|-<br />
|collision<br />
|string<br />
|collision<br />
|The name of the perception to be used when a collision perception is to be fired.<br />
|-<br />
|out_of_bounds<br />
|string<br />
|out of bounds<br />
|The name of the perception to be used when a out of bounds perception is to be fired.<br />
|-<br />
|in_bounds<br />
|string<br />
|in bounds<br />
|The name of the perception to be used when a in bound perception is to be fired.<br />
|}<br />
<br />
The most basic behavior operation in npcclient is <move>. It simply tells the npc to move forward<br />
at a certain speed in the direction he is currently pointing, and to play a named animation while<br />
doing so.<br />
<br />
Ex: <move vel="1" anim="walk" /><br />
<move anim="walk" vel="$WALK" out_of_bounds="move_outside_region" /><br />
<br />
This operation has no preset end or duration, so it will go until the behavior is preempted by another<br />
higher priority behavior such as the one to turn, triggered by a collision perception. (See the next<br />
section for a more detailed explanation of how behaviors pre-empt each other and change<br />
priorities.)<br />
<br />
This operation has low networking overhead since all it does is trigger a single Dead Reckoning<br />
(DR) update to start the forward motion. It does have CPU overhead during the entire duration of it<br />
running though, since there is no way for npcclient to know what it might hit along this path. Every<br />
500msec this operation wakes up and checks its latest movement for collisions, generating a<br />
perception called “collision” for the behavior script to react to. Also at each 500msec checkpoint,<br />
it checks the owner NPC’s region setting (such as “sunny meadow” in the example above), and if<br />
there is a region specifed, the operation checks its current position to make sure the NPC is still “in<br />
bounds”. If the NPC has made it outside the region in the last half second, it fires a perception<br />
called “out of bounds”. It will not fire another “out of bounds” perception until an “in bounds”<br />
perception has been detected.<br />
<br />
== MovePath Operation ==<br />
(Net load: 2, CPU Load: 3) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|path<br />
|string<br />
|Mandatory<br />
|The name of the path to use for the movement.<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The name of the animation to use for this movement<br />
|-<br />
|direction<br />
|FORWARD,REVERSE<br />
|FORWARD<br />
|The direction to move along the path<br />
|}<br />
<br />
This operation tell the NPC to move in a predefined path. The path is a named entity in the path network. <br />
From a start waypoint to and end waypoint with any number of path points in between. The path will either<br />
be followed in the forward or reverse direction. Upon start of this the npc will be forced to the<br />
start position of the path. The following example will move the NPC the reverse path to the clock tower.<br />
Ex: <movepath path="Clock Tower" direction="REVERSE" /><br />
<br />
Ex: <behavior "Ring the Clock"><br />
<movepath path="Clock Tower" /><br />
<wait anim="Ring the Clock" /><br />
<movepath path="Clock Tower" direction="REVERSE" /><br />
</behavior><br />
<br />
Current implementation will extrapolate on the server and send updates to the client.<br />
<br />
The following old description isn't quite in line with current implementation. Sure it should be possible<br />
to send the path to the client and do the math there. Suggest to include that as a option to the current<br />
implementation. With today implementation the movement could be interrupted and it will stop when finished<br />
with the path. To get the looping behavior either the behavior should be set to looping or a loop should<br />
be created.<br />
<br />
--Start old description:<br />
<br />
This operation is another very easy one: <movepath>. It tells the npc to set its preset path to a 3d<br />
spline specified in another file by name. Each client will take care of playing the right animations<br />
along the spline as the npc progresses. The intent of this operation was really simply for birds to be<br />
able to fly through the air as decoration rather than any gameplay reason. Aside from birds, most<br />
creatures do not follow 3d spline paths in their normal behaviors.<br />
<br />
Ex: <movepath path="bird1" /><br />
<br />
This operation has no present end or duration, and will actually loop if not stopped by another<br />
behavior.<br />
<br />
This operation has almost no network overhead, as the packed bytes of the spline are sent 1 time<br />
across the network to anyone needing to see this npc, and no other network activity happens until<br />
the <movepath> operation is interrupted.<br />
<br />
This operation also has almost zero CPU overhead, because there is no collision detection and no<br />
bounds checking on this type of movement. The reasoning is that since predefined paths are being<br />
followed, it is up to the designer/scripter to ensure that the path goes where they want it to and does<br />
not hit anything along the way.<br />
<br />
--End old description<br />
<br />
== MoveTo Operation ==<br />
(Net load: 0, CPU Load: 3) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|x<br />
|float<br />
|0.0<br />
|X-coordinate to move to<br />
|-<br />
|y<br />
|float<br />
|0.0<br />
|Y-coordinate to move to<br />
|-<br />
|z<br />
|float<br />
|0.0<br />
|Z-coordinate to move to<br />
|-<br />
|vel<br />
|float,$WALK,$RUN<br />
|Default is to use the velocity from the behavior.<br />
|The velocity to use when moving.<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The name of the animation to use<br />
|}<br />
<br />
This operation tells the npc to turn and face a certain point in<br />
3d space, then move in a straight line to that location at a certain speed. The turn is not animated,<br />
so if you want an animated turn, you need a <rotate> op in front of this (see below). <moveto> also<br />
specifies an animation name to play while performing this move.<br />
<br />
Ex: <moveto x="-38" y="0" z="-169" anim="walk" /><br />
<br />
When this operation is executed, the angle necessary to point in the right direction towards this 3d<br />
coordinate is calculated and the DR message to start the anim, start the movement and set the<br />
rotation angle so it will look correct is sent. Then the operation calculates the time it will take to<br />
traverse the distance at the specified speed and suspends itself for that length of time before waking<br />
up and completing. Thus, this operation has zero processing during these ½ second update<br />
opportunities. No CD checking is done and no bounds checking is done.<br />
<br />
When the operation wakes up a few seconds later, the <moveto> is considered complete, and<br />
npcclient sends another DR message to stop the movement.<br />
<br />
While this operation is very cheap, it is also not very flexible because the coordinates are in the<br />
NPCType and not in the NPC. Thus any NPC using this NPC Type with this command in it is<br />
going to have to be willing to move to this exact 3d coordinate.<br />
<br />
== Navigate Operation ==<br />
(Net load: 1, CPU Load 1) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to use in the navigation.<br />
|-<br />
|failure<br />
|string<br />
|<br />
|The perception to fire if the operation fails.<br />
|}<br />
<br />
<br />
The <navigate> operation is a placeholder right now and is simpler than it will be in the future. It is<br />
designed to work with <locate> and it moves the NPC in a straight line to the target location found<br />
by the <locate> operation.<br />
<br />
Ex: <navigate anim="walk" /><br />
<br />
The only thing the operation specifies is the animation to play while moving. It works much like<br />
<moveto> but uses the locate target destination instead of a single fixed location. The only network<br />
overhead are the Start and Stop DR messages, and the only CPU overhead is calculating how long<br />
to sleep between starting and stopping.<br />
<br />
For more complex movement the [[Behavior_Operations#Wander_Operation|Wander Operation]] should be<br />
used that will use the path network to navigate. Though if there are no path directly to the location<br />
to where the NPC should go a combination of Wander and Navigate could be used. Like this example<br />
where wander is used to navigate using waypoints and navigate is used navigate into the exact<br />
position of the tavern.<br />
<br />
Ex <locate obj="tavern" static="yes" random="yes" range="800" > <!-- Locate my favorite tavern --><br />
<wander /> <br />
<navigate /><br />
<br />
== NOP Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
This is a no operation operation. It does absolutely nothing, though each behavior needs to have a set of operations, if nothing else insert this nop operation.<br />
<br />
Ex: <nop /><br />
<br />
== Percept Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|event<br />
|string<br />
|<br />
|The name of the perception event to fire. [[NPC Variables]] will be replaced.<br />
|-<br />
|target<br />
|self,tribe,all,target<br />
|self<br />
|The recipient of this perception<br />
|-<br />
|type<br />
|string<br />
|(null)<br />
|The perception type. [[NPC Variables]] will be replaced.<br />
|-<br />
|range<br />
|float<br />
|0.0<br />
|If set to something greater than 0.0 this perception will only be delivered if within that range.<br />
|-<br />
|condition<br />
|string<br />
|<br />
|A [[NPCClient math script]] that if set will be evaluated and any non zero return value will cause the perception event to be fired.<br />
|-<br />
|failed_event<br />
|string<br />
|<br />
|The event to percept if the condition fail. [[NPC Variables]] will be replaced.<br />
|-<br />
|delayed<br />
|float<br />
|0.0<br />
|The amount of time to delay before the perception is fired. [[NPC Variables]] will be replaced.<br />
|}<br />
This operation allows an NPC to fire a custom [[Behaviors_and_Reactions#Perceptions|perception]] to himself.<br />
<br />
Ex: <percept event="done wandering" /><br />
<percept event="need help" target="tribe" range="50" /><br />
<percept event="GoToSleep" condition="DiurnalNight" delayed="10" /><br />
<br />
== Pickup Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|obj<br />
|string,perception<br />
|perception<br />
|The object to pick up. (Only perception implemented)<br />
|-<br />
|count<br />
|int<br />
|1<br />
|Number of objects to pick up<br />
|-<br />
|equip<br />
|slot<br />
|<br />
|name of slot to equip the item in (Not implemented)<br />
|}<br />
This operation allows an NPC to pickup an item he finds on the ground, and optionally equip(Not implemented) it if he can use it. Only objects that are pickable will be picked up.<br />
<br />
Ex: <pickup obj="perception" count="2" /><br />
<pickup obj="perception" equip="righthand" /> (Not Implemented)<br />
<br />
== Release Control Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
Release the control of a player.<br />
<br />
Ex: <release_control /><br />
<br />
== Reproduce Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|type<br />
|string<br />
|<br />
|The tribe member type for this. [[NPC Variables]] will be replaced.<br />
|}<br />
<br />
The reproduce operation will spawn the target with the type given. Tribes will use this to create different types of members (See: [[Tribe_Scripting#Select|Select]] statement in [[Tribe Scripting]]).<br />
<br />
Ex: <reproduce type="Warrior" /><br />
<br />
To make make a copy of your self<br />
<br />
Ex: <locate obj="self" /><br />
<reproduce /><br />
<br />
== Resurrect Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No Parameters.<br />
<br />
This operation will resurrect a tribe member within the radius of tribe home.<br />
<br />
Ex: <resurrect /><br />
<br />
This operation should be placed in an behavior that will be executed for dead NPCs. The reaction should<br />
as well have the when_dead flag set.<br />
<br />
Ex: <behavior name="Resurrect" completion_decay="200" growth="0" initial="0" when_dead="yes"><br />
<resurrect/><br />
</behavior><br />
<react event="tribe:resurrect" behavior="Resurrect" inactive_only="yes" when_dead="yes" /><br />
<br />
== Reward Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|resource<br />
|string,tribe:wealth<br />
|Mandatory<br />
|The resource to reward to the tribe. [[NPC Variables]] will be replaced.<br />
|-<br />
|count<br />
|int<br />
|1<br />
|The number of resource to reward.<br />
|}<br />
<br />
Will reward a tribe with a resource. Using the special ''tribe:wealth'' keyword will result in a lockup in the tribe for whats the wealth resource.<br />
<br />
Ex: <reward resource="Gold Ore" count="2" /><br />
<reward resource="tribe:wealth" /><br />
<br />
== Rotate Operation ==<br />
(Net load: 1, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|type<br />
|See table below.<br />
|Mandatory<br />
|The type of rotation operation to perform.<br />
|-<br />
|ang_vel<br />
|float<br />
|0.0<br />
|Angular velocity in degree. If 0 the NPC default angular velocity will be used.<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to use for the rotation operation<br />
|-<br />
|max<br />
|float<br />
|0.0<br />
|For inregion and random a range can be defined.<br />
|-<br />
|min<br />
|float<br />
|0.0<br />
|For inregion and radom a range can be defined.<br />
|-<br />
|value<br />
|float<br />
|0.0<br />
|For absolute and relative a value to add in degrees should be given.<br />
|}<br />
<br />
{|<br />
!Type<br />
!Description<br />
|-<br />
|inregion<br />
|<br />
|-<br />
|random<br />
|<br />
|-<br />
|absolute<br />
|<br />
|-<br />
|relative<br />
|<br />
|-<br />
|locatedest<br />
|Face in the direciton of the last located position.<br />
|-<br />
|locaterotation<br />
|Face in the direction of the last located rotation angle.<br />
|-<br />
|target<br />
|<br />
|-<br />
|}<br />
<br />
This operation <rotate> can be used to turn to a certain angle, to turn a relative amount, to turn a<br />
random amount or to turn to face a previously located object. This turn is animated, to give a more<br />
realistic look.<br />
<br />
Ex: <rotate type="random" min="90" max="270" anim="walk" vel="30" /><br />
<rotate type="locatedest" anim="walk" vel="90" /><br />
<br />
The first example here is a random turn of between 90 and 270 degrees from the current heading,<br />
with an angular velocity of 30 degrees per second, while playing the “walk” animation. 30 degrees<br />
per second means that the maximum turn of 270 degrees will take the npc 9 seconds.<br />
<br />
In the second example, we have already used our <locate> operation to find a point of interest near<br />
us, and we want to turn to point directly at it. Here a different (faster) angular velocity is specified<br />
but other angles aren’t necessary because they are implied by the current position of the NPC and<br />
the located special destination.<br />
<br />
This operation requires a DR update to start and stop the rotation, as the only networking overhead.<br />
CPU overhead is also minimal since npcclient calculates the time required to turn the full amount<br />
and puts this script to sleep for that many msec until the turn is done, then stops it.<br />
<br />
== Script Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|string<br />
|Mandatory<br />
|The name of the script<br />
|}<br />
<br />
Run a progression script. Target and Actor env is set for the script at the server.<br />
Ex: <script name="my_script" /><br />
<br />
== Sequence Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|name<br />
|string<br />
|Mandatory<br />
|The name of the sequence to control<br />
|-<br />
|cmd<br />
|start,stop,loop<br />
|Mandatory<br />
|The control of the sequence to issue.<br />
|-<br />
|count<br />
|int<br />
|1<br />
|The number of times to loop the sequence.<br />
|}<br />
<br />
Sequences are defined in the map file. They can be started, stopped, or played a number of time with the loop command. This allow the NPC to interact with large animation of world objects. This<br />
could be a winch that should run only when manned, a folding bridge or door that open and close etc.<br />
Ex: <sequence name="winch_up" cmd="start" /><br />
<br />
== Set Buffer Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|buffer<br />
|string<br />
|Mandatory<br />
|The name of the buffer.<br />
|-<br />
|value<br />
|string<br />
|Mandatory<br />
|The value to set for the buffer.<br />
|-<br />
|type<br />
|npc,tribe<br />
|npc<br />
|The type of buffer to set.<br />
|}<br />
<br />
Set either a NPC or a Tribe buffer. [[NPC Variables]] $NBUFFER[Buffer] (NPC Buffer) and $TBUFFER[Buffer] (Tribe Buffer) are replaced multiple places with the value of the buffer. <br />
<br />
Ex: <set_buffer buffer="Building" value="Small Tent" /><br />
<br />
== Share Memories Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No parameters<br />
<br />
This operation will share all private memories of the NPC with the tribe. Private memories is created with the [[Behavior_Operations#Memorize_Operation|Memorize Operation]]. They can be retrived by the [[Behavior_Operations#Locate_Operation|Locate Operation]] using tribe:memory:"memory name". Memories can also be crated using the [[Behavior_Operations#Auto_Memorize_Operation|Auto Memorize Operation]].<br />
<br />
Ex: <share_memories /><br />
<br />
== Sit Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No parameters.<br />
<br />
Sit tells the npc to sit down. Use [[Behavior_Operations#Standup_Operation|standup operation]] to stand up again.<br />
Ex: <sit /><br />
<br />
== Standup Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No parameters.<br />
<br />
Standup tells the npc to stand up. Use [[Behavior_Operations#Sit_Operation|sit operation]] to sit down again.<br />
Ex: <standup /><br />
<br />
== Talk Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|target<br />
|boolean<br />
|true<br />
|Talk to current target<br />
|-<br />
|text<br />
|string<br />
|<br />
|The string to send<br />
|-<br />
|public<br />
|boolean<br />
|true<br />
|Should this talk go to everyone in range, or only the target if public=false.<br />
|-<br />
|type<br />
|say,me,my,narrate<br />
|say<br />
|The type of talk.<br />
|-<br />
|command<br />
|string<br />
|<br />
|A perception to send to target if it is a NPC. [[NPC Variables]] will be replaced.<br />
|}<br />
<br />
If target is false, this will queue a talk command to the server from the NPC. If target is true and a target exists the same talk command will be sent to the server but a "''command''" perception will be sent to the<br />
target as well. The target will than be able to react to this perception.<br />
<br />
Ex: <talk target="true" text="Kneel in front of me." command="kneel" /><br />
<talk type="me" text="is angry" /><br />
<talk target="true" text="This message is only for you" public="false" /><br />
<br />
== Teleport Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
<br />
Teleport the NPC to the current active location.<br />
<br />
Ex: <teleport /><br />
<br />
== Transfer Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|item<br />
|string,tribe:wealth<br />
|Mandatory<br />
|The name of the item to transfer. [[NPC Variables]] will be replaced.<br />
|-<br />
|target<br />
|tribe<br />
|Mandatory<br />
|The target for this transfer.<br />
|-<br />
|count<br />
|int<br />
|-1<br />
|Number of items to transfer. -1 is all items. <br />
|}<br />
<br />
Transfere a number of item from one NPC to the target. <br />
<br />
Ex: <transfer item="tribe:wealth" target="tribe" /><br />
<br />
This example will transfer all of the tribe wealth from the NPC to the tribe.<br />
<br />
== Tribe Home Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No Parameters.<br />
<br />
Move the tribe home to the last active position of the NPC. This operation will issue a "tribe:home moved" perception to all members of the tribe.<br />
<br />
Ex: <tribe_home /><br />
<br />
== Tribe Type Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|type<br />
|string<br />
|<br />
|Change tribe member type.<br />
|-<br />
|}<br />
No Parameters.<br />
<br />
Change the Tribe Member type of the current NPC to the new type.<br />
<br />
Ex: <tribe_type type="Queen" /><br />
<br />
== Unbuild Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
Tribe operation.<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|}<br />
<br />
Unbuild a building. The building has to be targeted.<br />
<br />
Ex: <unbild /><br />
<br />
== Visible Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|}<br />
No Parameters.<br />
<br />
This operation makes the NPC visible if it where invisible. See [[Behavior_Operations#Invisible_Operation|Invisible Operation]].<br />
<br />
Ex: <visible /><br />
<br />
== Wait Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|duration<br />
|float<br />
|Mandatory<br />
|The duration to wait. [[NPC Variables]] will be replaced.<br />
|-<br />
|random<br />
|float<br />
|0.0<br />
|The random duration to wait. [[NPC Variables]] will be replaced.<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to play while waiting.<br />
|}<br />
<br />
This operation makes the NPC wait a specified length of time before progressing to the next<br />
operation. It will loop an animation during this time also for you, so you can use it for crafting<br />
actions, guard monitoring, or whatever you need that is a timed animated activity.<br />
<br />
Ex: <wait duration="30" anim="stand" /><br />
<wait duration="$NBUFFER[Sit_Duration]" anim="sit" /><br />
<br />
This example tells the NPC to play the “stand” animation and do nothing for 30 seconds. This<br />
requires a network DR message with the specified animation, and another to stop the animation<br />
when the duration is over. There is almost no CPU required because the script goes to sleep for the<br />
duration and is woken up automatically at the end.<br />
<br />
As with any other scripted operation, this operation can be interrupted if another behavior preempts<br />
this one from completing. So if an npc is playing the above operation, and just standing there for<br />
30 seconds, and is attacked by someone, presumably an attack behavior would become top priority<br />
and the npc would stop waiting and attack back.<br />
<br />
This concludes the section on the detailed operations possible with npc scripting today. Now we<br />
will discuss how these operations work together to define behaviors and how behaviors interact<br />
with each other.<br />
<br />
== Wander Operation ==<br />
(Net load: 2, CPU Load 1) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|anim<br />
|string<br />
|<br />
|The animation to play while wandering.<br />
|-<br />
|vel<br />
|float<br />
|<br />
|<br />
|-<br />
|random<br />
|boolean<br />
|false<br />
|Turn on never ending random wandering.<br />
|-<br />
|underground<br />
|boolean<br />
|invalid<br />
|If not set ignore underground, set true only wander underground, if set false never wander underground waypoints<br />
|-<br />
|underwater<br />
|boolean<br />
|invalid<br />
|If not set ignore underwater, set true only wander underwater, if set false never wander underwater waypoints<br />
|-<br />
|private<br />
|boolean<br />
|invalid<br />
|If not set ignore private, set true only wander private, if set false never wander private waypoints<br />
|-<br />
|public<br />
|boolean<br />
|invalid<br />
|If not set ignore public, set true only wander public, if set false never wander public waypoints.<br />
|-<br />
|city<br />
|boolean<br />
|invalid<br />
|If not set ignore city, set true only wander city, if set false never wander city waypoints.<br />
|-<br />
|indoor<br />
|boolean<br />
|invalid<br />
|If not set ignore indoor, set true only wander indoor, set false never wander indoor waypoints.<br />
|}<br />
<br />
Using random <move> and <rotate> operations works well for creating randomized wandering<br />
behaviors in open, outdoor spaces and scripters should be using that approach there. However, in tighter, indoor areas like the hydlaa sewers or the dungeon, a more specific type of randomness is required.<br />
<br />
The <wander> operation makes the npc in question walk between an independently defined set of<br />
“waypoints”. Each waypoint is a 3d coordinate and a tolerance radius. The radius adds a ‘fuzzy’<br />
factor so that multiple npcs sharing the same set of waypoints will not all walk to the exact same<br />
centimeter location. Even in tight locations, a tolerance radius of .5-1m will be a lot better than 0m. Waypoints will be created with the path system available as GM commands.<br />
<br />
Ex: <wander anim="walk" /><br />
<br />
As you see, the only thing specified by the wander operation is the animation to play while<br />
wandering. The NPC starts by walking to the nearest waypoint to its current location, then follows<br />
the waypoint choices to decide where to go next. This operation will take the NPC to the current active<br />
waypoint as selected by the last [[Behavior_Operations#Locate_Operation|Locate Operation]].<br />
<br />
Each waypoint have a set off properties. It can be marked as indoor,underground,underwater,private,public, or city.<br />
If the wander operations in specified with the indoor flag set to true only waypoints with the indoor attribute set to true will be used when wandering. Changing<br />
waypoint attributes can be done by the GM command /path (TBD, Not impemented yet, has to be done in DB for now).'<br />
<br />
Each waypoint is connected with a [[Sc_waypoint_linksTable|path]]. The path has a set of properites like TELEPORT, NO_WANDER, ONEWAY.<br />
<br />
This operation is very light on the network because it is all straight-line navigation between known,<br />
preset points. There is 1 DR update per point hit by the npc. It is also quite light on CPU power<br />
requirements because the points are known, which means no collision detection has to be done.<br />
<br />
One tricky thing about this is that normally non-horizontal walking is accomplished on the client<br />
with collision detection with the ground/stairs. In order to get the most accurate-looking result on<br />
the client, the client DOES do collision detection on these npcs. However, npcclient does simple<br />
linear interpolation between the starting and ending y-coordinates of the 2 waypoints as an<br />
approximation. Thus the server and client will not have the identical y-coordinate in all cases. This<br />
should almost never be noticeable, though.<br />
<br />
== Watch Operation ==<br />
(Net load: 0, CPU Load: 0) <br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|type<br />
|nearest_actor,nearest_npc,nearest_player,owner,target<br />
|Mandatory<br />
|The type of watch to do.<br />
|-<br />
|range<br />
|float<br />
|0.0<br />
|The watch range. A perception will be generated when watched entity move out of range.<br />
|-<br />
|invisible<br />
|boolean<br />
|false<br />
|Set to true to watch invisible entities.<br />
|-<br />
|invincible<br />
|boolean<br />
|false<br />
|Set to true to watch invincible entities.<br />
|-<br />
|search_range<br />
|float<br />
|2.0<br />
|When watching nearest, this range set the limit for how fare that entity can be.<br />
|}<br />
<br />
Watch over nearby entities. The "nearest out of range","owner out of range", or "target out of range" perception will be generated when the watched entity move out of range.<br />
<br />
Ex: <behavior name="Watch"><br />
<watch type="owner" range="3.0" /><br />
</behavior><br />
<react event="owner out of range" behavior="follow_chase" /><br />
<br />
In this example the NPC will watch the owner. If the owner move out of the watch range 3.0 the "owner out of range" perception will be fired and the new follow_chase behavior will start.<br />
<br />
== Work Operation ==<br />
(Net load: 0, CPU Load: 0)<br />
<br />
{|<br />
!Parameter<br />
!Type<br />
!Default<br />
!Description<br />
|-<br />
|type<br />
|dig,fish,harvest<br />
|Mandatory<br />
|The type of work to do<br />
|-<br />
|resource<br />
|string,tribe:wealth<br />
|Mandatory<br />
|Resource to work for or by using the keyword tribe:wealth look up in the tribe to find the resource.<br />
|}<br />
<br />
Order an NPC to start digging for a resource. The keyword "tribe:wealth" will cause the resource to be looked up in the wealth_resource_nic field in the [[NPC_Behavior_Data_Structures#tribes|tribes]] table if the NPC is part of a tribe.<br />
<br />
Ex: <work type="dig" resource="tribe:wealth" /><br />
<work type="dig" resource="Gold Ore" /><br />
<br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]] [[Category:NPCClient Scripting]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20175Scriptable Entities Design2013-12-30T23:35:51Z<p>Magodra: /* Message Sequence Script Hire */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB. Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object.<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequences ===<br />
<br />
Sequence diagrams with focus on the messages going between the different programs.<br />
<br />
==== Message Sequence Start Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
==== Message Sequence Confirm Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
==== Message Sequence Script Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
== Start ==<br />
Player -> Client: Select context menu script<br />
Client -\\ Server : psHiredNPCScriptMessage<br />
activate Server<br />
note right: "Request script"<br />
Client //- Server : psHiredNPCScriptMessage<br />
deactivate Server<br />
note right: "Request Reply with script"<br />
Player <- Client : Display Script Dialog<br />
== Set Work Location ==<br />
Player -> Client: Push work location<br />
Client -\\ Server : psHiredNPCScriptMessage<br />
note right: "Work Location"<br />
activate Server<br />
Server -> Server : Get Current Location<br />
Server -\\ NPCClient : CheckWorkLocation<br />
note right<br />
Verify that location is close to a waypoint<br />
and that a path from location to waypoint<br />
can be found.<br />
end note<br />
activate NPCClient<br />
Server //-- NPCClient<br />
deactivate NPCClient<br />
Client //- Server : psHiredNPCScriptMessage<br />
note right: "Result from location verification"<br />
deactivate Server <br />
== Script ==<br />
Player -> Client: Edit script<br />
Player -> Client: Push Validate<br />
Client -\\ Server : psHiredNPCScriptMessage<br />
note right: "Validate script"<br />
activate Server<br />
Client //- Server : psHiredNPCScriptMessage<br />
deactivate Server<br />
note right: "Validate Reply"<br />
Player <- Client : Update Script Dialog<br />
== Confirm ==<br />
Player -> Client: Push Confirm<br />
</uml><br />
<br />
=== Server Sequence Diagrams ===<br />
Sequence diagrams showing whats going on inside the server.<br />
<br />
==== Server Start Hire Sequence ====<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
==== Server Confirm Hire Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
==== Server Script Hired NPC Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
-guild : bool<br />
-script : csString<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20174Scriptable Entities Design2013-12-30T23:23:17Z<p>Magodra: /* Message Sequence Confirm Hire */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB. Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object.<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequences ===<br />
<br />
Sequence diagrams with focus on the messages going between the different programs.<br />
<br />
==== Message Sequence Start Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
==== Message Sequence Confirm Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
==== Message Sequence Script Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select context menu script<br />
Client -\\ Server : psHiredNPCScriptMessage<br />
activate Server<br />
note right: "Request script"<br />
Client //- Server : psHiredNPCScriptMessage<br />
deactivate Server<br />
note right: "Request Reply with script"<br />
Player <- Client : Display Script Dialog<br />
</uml><br />
<br />
=== Server Sequence Diagrams ===<br />
Sequence diagrams showing whats going on inside the server.<br />
<br />
==== Server Start Hire Sequence ====<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
==== Server Confirm Hire Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
==== Server Script Hired NPC Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
-guild : bool<br />
-script : csString<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20173Scriptable Entities Design2013-12-30T14:05:37Z<p>Magodra: /* Classes */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB. Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object.<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequences ===<br />
<br />
Sequence diagrams with focus on the messages going between the different programs.<br />
<br />
==== Message Sequence Start Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
==== Message Sequence Confirm Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
=== Server Sequence Diagrams ===<br />
Sequence diagrams showing whats going on inside the server.<br />
<br />
==== Server Start Hire Sequence ====<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
==== Server Confirm Hire Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
==== Server Script Hired NPC Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
-guild : bool<br />
-script : csString<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20172Scriptable Entities Design2013-12-30T12:51:10Z<p>Magodra: /* Database */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB. Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object.<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequences ===<br />
<br />
Sequence diagrams with focus on the messages going between the different programs.<br />
<br />
==== Message Sequence Start Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
==== Message Sequence Confirm Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
=== Server Sequence Diagrams ===<br />
Sequence diagrams showing whats going on inside the server.<br />
<br />
==== Server Start Hire Sequence ====<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
==== Server Confirm Hire Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
==== Server Script Hired NPC Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20171Scriptable Entities Design2013-12-30T12:21:19Z<p>Magodra: /* Internal Sequence Diagrams */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequences ===<br />
<br />
Sequence diagrams with focus on the messages going between the different programs.<br />
<br />
==== Message Sequence Start Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
==== Message Sequence Confirm Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
=== Server Sequence Diagrams ===<br />
Sequence diagrams showing whats going on inside the server.<br />
<br />
==== Server Start Hire Sequence ====<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
==== Server Confirm Hire Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
==== Server Script Hired NPC Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20170Scriptable Entities Design2013-12-30T12:20:13Z<p>Magodra: /* Sequence Diagrams */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequences ===<br />
<br />
Sequence diagrams with focus on the messages going between the different programs.<br />
<br />
==== Message Sequence Start Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
==== Message Sequence Confirm Hire ====<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
=== Internal Sequence Diagrams ===<br />
Sequence diagrams showing whas going on inside each program.<br />
<br />
==== Server Start Hire Sequence ====<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
==== Server Confirm Hire Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
==== Server Script Hired NPC Sequence ====<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20169Scriptable Entities Design2013-12-30T12:14:02Z<p>Magodra: /* Message Sequence Hire */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Start Hire ===<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Message Sequence Confirm Hire ===<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
=== Server Script Hired NPC Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20168Scriptable Entities Design2013-12-30T12:13:05Z<p>Magodra: /* Message Sequence Hire */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, Database<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Message Sequence Confirm Hire ===<br />
<br />
<uml><br />
actor Player<br />
participant Client<br />
participant Server<br />
participant NPCClient<br />
database Database<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
=== Server Script Hired NPC Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20167Scriptable Entities Design2013-12-30T11:33:19Z<p>Magodra: /* Server Confirm Hire Sequence */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
=== Server Script Hired NPC Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
participant HireManager<br />
participant HireSession<br />
database Database<br />
<br />
<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20166Scriptable Entities Design2013-12-30T11:30:09Z<p>Magodra: /* Server Confirm Hire Sequence */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
activate HireManager<br />
HireManager -> HireSession : VerifyPendingHireConfigured<br />
HireManager -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
deactivate EntityManager<br />
HireManager -> HireSession : SetHiredNPC<br />
HireManager -> HireSession : Save<br />
deactivate HireManager<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20165Scriptable Entities Design2013-12-30T11:20:12Z<p>Magodra: /* Server Confirm Hire Sequence */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
HireManager -> HireSession : HireConfirmed<br />
activate HireSession<br />
HireSession -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager<br />
participant NpcManager<br />
database Database<br />
EntityManager -> Database : Copy of master NPC<br />
EntityManager -> NpcManager : NewNPCNotify<br />
NpcManager -\\ Network : psNewNPCCreatedMessage<br />
EntityManager -\\ Network : psPersistActor<br />
HireSession <-- EntityManager : hiredNPC<br />
deactivate EntityManager<br />
HireSession -> HireSession : SetHiredNPC<br />
HireSession -> NpcManager : QueueHiredNPCCmd<br />
note right: TBD what information is needed to the NPC Client here.<br />
NpcManager -\\ Network : psNPCCommandsMessage<br />
deactivate HireSession<br />
HireManager -> HireSession : Save<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20164Scriptable Entities Design2013-12-30T11:12:21Z<p>Magodra: /* Message Sequence Hire */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Server -\\ NPCClient : psNewNPCCreatedMessage<br />
NPCClient -> Database : sc_npc_definition<br />
note right: Update NPC definition with record for new NPC.<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
HireManager -> HireSession : HireConfirmed<br />
activate HireSession<br />
HireSession -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager <br />
EntityManager -\\ Network : psPersistActor<br />
HireSession <-- EntityManager : hiredNPC<br />
deactivate EntityManager<br />
HireSession -> HireSession : SetHiredNPC<br />
HireSession -> NpcManager : QueueHiredNPCCmd<br />
note right: TBD what information is needed to the NPC Client here.<br />
NpcManager -\\ Network : psNPCCommandsMessage<br />
deactivate HireSession<br />
HireManager -> HireSession : Save<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20163Scriptable Entities Design2013-12-30T11:07:55Z<p>Magodra: /* Server Confirm Hire Sequence */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
HireManager -> HireSession : HireConfirmed<br />
activate HireSession<br />
HireSession -> EntityManager : CreateHiredNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager <br />
EntityManager -\\ Network : psPersistActor<br />
HireSession <-- EntityManager : hiredNPC<br />
deactivate EntityManager<br />
HireSession -> HireSession : SetHiredNPC<br />
HireSession -> NpcManager : QueueHiredNPCCmd<br />
note right: TBD what information is needed to the NPC Client here.<br />
NpcManager -\\ Network : psNPCCommandsMessage<br />
deactivate HireSession<br />
HireManager -> HireSession : Save<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20162Scriptable Entities Design2013-12-29T16:44:39Z<p>Magodra: /* Alternative 2 */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class npc_hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of npc_hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" npc_hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
HireManager -> HireSession : HireConfirmed<br />
activate HireSession<br />
HireSession -> EntityManager : CloneNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager <br />
EntityManager -\\ Network : psPersistActor<br />
HireSession <-- EntityManager : hiredNPC<br />
deactivate EntityManager<br />
HireSession -> HireSession : SetHiredNPC<br />
HireSession -> NpcManager : QueueHiredNPCCmd<br />
note right: TBD what information is needed to the NPC Client here.<br />
NpcManager -\\ Network : psNPCCommandsMessage<br />
deactivate HireSession<br />
HireManager -> HireSession : Save<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodrahttps://planeshift.top-ix.org//pswiki/index.php?title=Scriptable_Entities_Design&diff=20161Scriptable Entities Design2013-12-28T22:51:45Z<p>Magodra: /* Sequence Diagram */</p>
<hr />
<div>This desing realize the [[Scriptable Entities]] functionality.<br />
<br />
= Player Use Cases =<br />
<uml><br />
:Hiring Player: --> (Hire NPC)<br />
:Hiring Player: --> (Define Locations)<br />
:Hiring Player: --> (Script Hired NPC)<br />
:Hiring Player: --> (Release NPC)<br />
:Player: --> (Interact with Hired NPC\nNPC Dialogues)<br />
:Player: --> (Buy Items)<br />
</uml><br />
== Hire NPC ==<br />
Player can hire a NPC to do work for either the player or his guild. <br />
<br />
To limit the number of Hired NPCs each player will only be able to hire at most one NPC. Guild might be allowed to hire more NPCs.<br />
<br />
=== Activity Diagram ===<br />
<br />
Using a NPC that hiring out other NPCs to start the hire. Each activity involving player is performed using NPC Dialogues.<br />
<br />
<uml><br />
(*) --> "Target NPC that hires out NPCs"<br />
--> "Select working hours"<br />
--> "Select type of NPC to hire"<br />
--> "Confirm Hiring"<br />
--> "Activate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
==== Target NPC that hires out NPCs ====<br />
Player target an NPC that hires out other NPCs.<br />
<br />
==== Select working hours ====<br />
Through [[NPC Dialogues|NPC Dialogues]] the player can start a hiring process. The player will need to select if a night or day assignment is needed.<br />
<br />
Choices available:<br />
* Working day<br />
* Working night<br />
<br />
Example NPC dialogue:<br />
*Player: I would like to hire a NPC.<br />
*NPC: Would you like to hire for day or night?<br />
*Player: For day work.<br />
<br />
==== Select type of NPC to hire ====<br />
<br />
Through [[NPC Dialogues]] the player can select type of NPC to hire. Merchant Player will only be available if the player meet a set of requirements Example: Level in crafting. <br />
<br />
Choices available:<br />
* Guard<br />
* Merchant Player<br />
* Merchant Guild<br />
<br />
Example NPC dialogue:<br />
*NPC: Would you like a guard or a merchant?<br />
*Player: I would like to have a guard.<br />
<br />
==== Confirm Hiring ====<br />
<br />
Through [[NPC Dialogues]] the player should confirm that he would like to hire.<br />
<br />
<br />
Example NPC dialogue:<br />
*NPC: You can get one of my guard for 100 trias a day?<br />
*Player: I accept the conditions.<br />
<br />
==== Activate Hired NPC ====<br />
<br />
After hire is confirmed a NPC will be spawned and assigned to the hiring player. The hired NPC will than start to follow the player.<br />
<br />
== Define Locations ==<br />
Enable the Hire to define locations used when scripting their hired NPCs. This would be Work Locations and Guard Locations.<br />
<br />
Using the /location command enabling players to define locations for Scripting Hired NPCs. Might need some kind of association so that when character/guild is deleted the location is deleted as well.<br />
<br />
=== Activity Diagram ===<br />
<uml><br />
(*) --> "Go to location"<br />
--> "Define new location"<br />
--> (*)<br />
</uml><br />
<br />
== Script Hired NPC ==<br />
Hired NPCs can be scripted. User open the [[Script Hired NPC Dialog]] to enter new scripts for the NPC.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired NPC Dialog"<br />
--> "Select Work Location"<br />
--> [Guard Service] "Select Guard Locations"<br />
--> "Edit Custom Script"<br />
"Select Work Location" --> [Sell Items] "Select Item Source"<br />
--> "Edit Custom Script"<br />
--> "Validate Script"<br />
if "Valid" then<br />
-down-> [true] "Confirm Script"<br />
--> "Store and activate script"<br />
--> (*)<br />
else<br />
-right-> [false] "Edit Custom Script"<br />
endif<br />
</uml><br />
<br />
==== Identify Item Source ====<br />
Select the source of the items to be sold. For Guilds this will be a container the guild dedicate to serve as the storage for the hired merchant.<br />
<br />
==== Select Work Location ====<br />
From a list of locations defined by the Player using the /locate operation a work location can be defined for the Hired NPC.<br />
<br />
==== Validate Script ====<br />
It is important that only valid scripts are given to the server. Need to make sure that the script is correct before script is stored in the db and assigned to the NPC. This validation should identify illegal syntax, validate that the commands are ok for players to use. As an example commands that create new items will not be available for players. See [[Custom NPC Dialogue|Custom NPC Dialogues]] for details.<br />
<br />
== Release NPC ==<br />
A NPC that is no longer needed can be released. This will be done from the [[Script Hired NPC Dialog]].<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Open Script Hired Dialog"<br />
--> "Release Hired NPC"<br />
--> "Confirm Release"<br />
--> "Store and deactivate Hired NPC"<br />
--> (*)<br />
</uml><br />
<br />
== Interact with Hired NPC ==<br />
Using the [[NPC Dialogues]] to interact with the NPC. [[Custom NPC Dialogue|Custom NPC Dialogues]] created through the Script Hired NPC process provides the input to the [[NPC Dialogues]] system to provide custom dialogues.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Talk"<br />
--> "Perform NPC Dialogue"<br />
--> "Select Bye"<br />
--> (*)<br />
</uml><br />
<br />
== Buy Items ==<br />
Using the standard interface to buy stuff from NPCs.<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Target NPC"<br />
--> "Select Buy"<br />
--> "Perform Trade"<br />
--> "Close Buy Dialog"<br />
--> (*)<br />
</uml><br />
<br />
= Admin Use Cases =<br />
In this context admin is defined as setting or rule team members.<br />
<br />
<uml><br />
:Admin: --> (Script NPC that hire out NPCs)<br />
</uml><br />
<br />
== Script NPCs that hire out NPCs ==<br />
<br />
This activity creates [[NPC Dialogues]] for the NPC that are going to hire out NPCs. <br />
<br />
<uml><br />
(*) --> Select NPCs that hire<br />
--> Create NPC Dialogue\nQuest<br />
-->(*)<br />
</uml><br />
<br />
=== Select NPCs that hire ===<br />
Selection of NPCs are outside scope of this design. That is part of the Setting process.<br />
<br />
=== Create NPC Dialogue ===<br />
<br />
The [[NPC Dialogues]] will through [[Response Operation|Response Operations]] define the hired NPCs. Each NPC that will hire out other NPCs might be different but they must include steps to:<br />
<br />
* Start Hire<br />
* Confirm Hire<br />
<br />
They might include steps to:<br />
* Select working hours<br />
* Select type of NPC to hire<br />
** Guard<br />
** Merchant Player Items<br />
** Merchant Guild Items<br />
* Select experience level<br />
** Trainee<br />
** Expert<br />
<br />
= Hired NPC Use Cases =<br />
<br />
<uml><br />
:Hired NPC: --> (Guard)<br />
:Hired NPC: --> (NPC dialogue)<br />
:Hired NPC: --> (Sell Player Items)<br />
:Hired NPC: --> (Sell Guild Items)<br />
</uml><br />
<br />
== Guard ==<br />
Perform Guard duties. Pre-programmed guard action. Player select working hours, working position, a number of check points and interval for checking thous.<br />
<br />
<uml><br />
(*) --> "Go to work"<br />
--> "Guard work position"<br />
--> [Walk interval] "Walk round"<br />
--> "Guard work position"<br />
--> [End of day] "Go home"<br />
--> (*)<br />
</uml><br />
<br />
== NPC dialogue ==<br />
Through Quest script syntax with user safe commands enabling custom scripts to be crated for the NPC.<br />
<br />
== Sell Player Items==<br />
NPC can sell items for the hiring player. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Players Items"<br />
--> "Perform Trade"<br />
--> "Update Hiring Players Items"<br />
--> (*)<br />
</uml><br />
<br />
== Sell Guild Items==<br />
NPC can sell guild items. Using the standard trade front end with the trading character.<br />
<br />
=== Activity Diagram ===<br />
<br />
<uml><br />
(*) --> "Player Request Sell Dialog"<br />
--> "Present Guild Items"<br />
--> "Perform Trade"<br />
--> "Update Guild Items"<br />
--> (*)<br />
</uml><br />
<br />
= Detailed Design =<br />
This section will detail some of the activities identified in the Use Cases above. Down to a level that identifies messages between client, server and npc client and some of the sequences in the server as needed.<br />
<br />
== Database ==<br />
To keep track of hired NPCs and store the scripts new elements will be needed in the DB.<br />
<br />
Two alternative solutions.<br />
<br />
=== Alternative 1 ===<br />
<br />
The character relationships record keep track of relationships between characters so extending with a new hired type should cover the need for this system. A new hired_npc_scripts record will be created to store the [[Custom NPC Dialogue|Custom NPC Dialogues]].<br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class character_relationships << (D,orchid) >>{<br />
+character_id<br />
+related_id<br />
+relationship_type<br />
+spousename<br />
}<br />
note right of character_relationships<br />
Relationship_type can be:<br />
*familiar<br />
*buddy<br />
*spouse<br />
*exploration<br />
*hired (NEW)<br />
end note<br />
<br />
character "2" -- "0..n" character_relationships : ><br />
<br />
class hired_npc_scripts << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npc_scripts<br />
NEW record to keep hired npc scripts.<br />
*hired_npc_id points to the NPC that is hired.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "1" -- "0..n" hired_npc_scripts : ><br />
</uml><br />
<br />
=== Alternative 2 ===<br />
<br />
Creating one new record to keep all information regarding hiring. This will be equivalent to the server side HireSession object. This seams like a cleaner approach than Alternative 1. <br />
<br />
<uml><br />
<br />
class character << (D,orchid) >> {<br />
+id<br />
} <br />
<br />
class hired_npcs << (D,orchid) >> {<br />
+hired_npc_id : int<br />
+owner_id : int<br />
+guild : bool<br />
+container_item_id : int<br />
+working_hours : TBD<br />
+work_location : TBD<br />
+guard_positions : TBD<br />
+script : TEXT<br />
}<br />
note right of hired_npcs<br />
NEW record to keep hired npc information.<br />
*hired_npc_id points to the NPC that is hired.<br />
*owner_id points to the player that hired this npc.<br />
*container_item_id points to the container<br />
containing items to be sold.<br />
*script contain a Custom NPC Dialogue<br />
end note<br />
<br />
character "2" -- "0..n" hired_npcs : ><br />
</uml><br />
<br />
== State Diagrams ==<br />
=== Hire Session States ===<br />
<uml><br />
[*] --> Hiring : Start Hire<br />
Hiring --> Hired<br />
Hired --> [*] : Release<br />
<br />
state Hired {<br />
[*] --> NotScripted<br />
NotScripted --> Scripted : Confirm Script<br />
state NotScripted as "Not Scripted"<br />
}<br />
<br />
</uml><br />
<br />
== Sequence Diagrams ==<br />
This section will be started when Use Cases has been agreed.<br />
<br />
=== Message Sequence Hire ===<br />
<br />
<uml><br />
actor Player<br />
Player -> Client : Context select<br />
Client -\\ Server : psUserActionMessage<br />
note right: action = context\nSee Context Menu Design for server details.<br />
Client //- Server : psGUIInteractMessage<br />
Player <- Client : Display Context menu<br />
Player -> Client : Select Talk<br />
Client -\\ Server : psUserCmdMessage<br />
note right: command = "/npcmenu"<br />
Client //- Server : psDialogMenuMessage<br />
Player <- Client : Display Dialog Menu<br />
Player -> Client : Select text<br />
note right: "I would like to hire a NPC"<br />
Client -// Server : psChatMessage<br />
Server -> Server : Start Hire<br />
database Database<br />
note over Player, NPCClient<br />
Some more sequences to decide working hour, type of NPC to hire, etc.<br />
Using more Dialog Menu Messages and Chat Messages. Server update HireSession. <br />
end note<br />
Player -> Client: Select text<br />
note right: "I confirm hiring"<br />
Client -\\ Server : psChatMessage<br />
Server -> Server : Confirm Hire<br />
Server -> Database : hired_npcs<br />
note right: Update hired_npcs with this new hire.<br />
Client //- Server : psChatMessage<br />
Player <- Client: Display chat<br />
note right: "You hired a NPC"<br />
Client //- Server : psPersistActor<br />
note right: Spawn the new Hired NPC<br />
Player <- Client : Display hired NPC<br />
Server -// NPCClient : psPersistActor<br />
Server -// NPCClient : psNPCCommandsMessage<br />
note right<br />
Server assign hired NPC to player.<br />
Add information to NPCClient about working location, guard positions etc. as applicable.<br />
end note<br />
Server //- NPCClient : psNPCCommandsMessage<br />
note right: Cmd DRDATA<br />
Client //- Server : psDRMessage<br />
Player <- Client: NPC Movement<br />
note right: Hired NPC moving up to player.<br />
</uml><br />
<br />
See also [[Context Menu Design]].<br />
<br />
=== Server Start Hire Sequence ===<br />
<br />
This sequence will establish the HireSession object in the HireManager. NetworkHandling is an abstraction of all the network related stuff.<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Question to start hiring.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : StartHire<br />
create HireSession<br />
HireManager -> HireSession<br />
</uml><br />
<br />
=== Server Confirm Hire Sequence ===<br />
<br />
<uml><br />
actor Network<br />
control NetworkHandling<br />
Network -\\ NetworkHandling : psChatMessage<br />
NetworkHandling -> ChatManager : HandleChatMessage<br />
note right: CHAT_NPC, Confirming hire.<br />
ChatManager -> ChatManager : CheckNPCResponse<br />
ChatManager -> NpcResponse : ExecuteScript<br />
NpcResponse -> HireManager : ConfirmHire<br />
HireManager -> HireSession : HireConfirmed<br />
activate HireSession<br />
HireSession -> EntityManager : CloneNPC<br />
note right: Spawn a new NPC<br />
activate EntityManager <br />
EntityManager -\\ Network : psPersistActor<br />
HireSession <-- EntityManager : hiredNPC<br />
deactivate EntityManager<br />
HireSession -> HireSession : SetHiredNPC<br />
HireSession -> NpcManager : QueueHiredNPCCmd<br />
note right: TBD what information is needed to the NPC Client here.<br />
NpcManager -\\ Network : psNPCCommandsMessage<br />
deactivate HireSession<br />
HireManager -> HireSession : Save<br />
</uml><br />
<br />
== Classes ==<br />
<br />
<uml><br />
class HireManager {<br />
+StartHire()<br />
+ConfirmHire()<br />
}<br />
<br />
class HireSession {<br />
-state : HireState;<br />
-ownerId : PID<br />
-hiredNPCId : PID<br />
+HireSession(owner:gemActor)<br />
+SetHiredNPC(hiredNPC:gemNPCActor)<br />
+HireConfirmed()<br />
+Save()<br />
}<br />
<br />
HireManager "1" *-- "0..n" HireSession : hireSessions<br />
</uml><br />
<uml><br />
ResponseOperation <|-- XXResponseOp<br />
<br />
class XXResponseOp{<br />
}<br />
note right<br />
Number of NEW operations.<br />
XX=StartHire,HireWorkingHour,HireNPCType,ConfirmHire,Etc.<br />
end note<br />
</uml><br />
<br />
= Utility Functions =<br />
<br />
== Admin /hire command ==<br />
A admin /hire command equivalent to the NPC Dialogues will be created to allow testing and verification. Will also work as a GM tool to manipulate hires.<br />
<br />
=== Sequence Diagram ===<br />
<br />
<uml><br />
actor Admin<br />
Admin -\\ Server : /hire start<br />
Server -> Server : Start New Hire<br />
Admin -\\ Server : /hire type "Merchant Guild"<br />
Server -> Server : Set type for hire session.<br />
Admin -\\ Server : /hire confirm<br />
Server -> Server : Confirm Hire<br />
Admin //- Server : New Hired NPC<br />
Admin -\\ Server : /hire release<br />
Server -> Server : Release Hire<br />
</uml><br />
<br />
<br />
[[Category:Engine documents]] [[Category:Server Design]]</div>Magodra