https://planeshift.top-ix.org//pswiki/api.php?action=feedcontributions&feedformat=atom&user=Naeg
PSwiki - User contributions [en]
2026-04-06T02:13:03Z
User contributions
MediaWiki 1.43.1
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10131
HowTo Add a NPC Operation
2013-04-04T16:35:24Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in networkmgr<br />
# Modify npcmessages<br />
# Process Command in npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/server/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug3(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemActor* actor = dynamic_cast<gemActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
if(actor)<br />
{<br />
if(psserver->GetUserManager()->CheckTargetLootable(actor, NULL))<br />
{<br />
psserver->GetUserManager()->LootMoney(actor, NULL);<br />
psserver->GetUserManager()->LootItems(actor, NULL, type);<br />
}<br />
// TODO: Add inventory change perception to make npc put items into tribe's resources<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Test ==<br />
<br />
Create a behavior to test with:<br />
<br />
Add new <behavior> and <react event> to AbstractTribesman in sc_npctypes.sql.<br />
<br />
<code><br />
<nowiki><br />
INSERT INTO sc_npctypes VALUES("109","AbstractTribesman","DoNothing,Move",0,"","","","","","1",<br />
'<!-- Abstract base npc type for tribes --><br />
<!-- [...] --><br />
<br />
<behavior name="test_loot" ><br />
<loot type="all"/><br />
</behavior><br />
<br />
<react event="test_loot" behavior="test_loot" /><br />
<!-- [...] --><br />
');</nowiki></code><br />
<br />
Reload the table:<br />
<br />
<code>mysql -u planeshift -pplaneshift planeshift<br />
<br />
mysql> source sc_npctypes.sql;</code><br />
<br />
On the psclient click on a NPC Hunter or Miner (has to be one of these due to "AbstractTribesman") and execute these commands:<br />
<br />
<code><br />
/debugnpc<br />
<br />
/percept test_loot test_loot</code><br />
<br />
Depending on where you sent DEBUG Messages, you can either see them in psnpcclient or psserver. Make sure LOG_SUPERCLIENT is active (setlog LOG_SUPERCLIENT).<br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10130
HowTo Add a NPC Operation
2013-04-02T22:04:25Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in networkmgr<br />
# Modify npcmessages<br />
# Process Command in npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Test ==<br />
<br />
Create a behavior to test with:<br />
<br />
Add new <behavior> and <react event> to AbstractTribesman in sc_npctypes.sql.<br />
<br />
<code><br />
<nowiki><br />
INSERT INTO sc_npctypes VALUES("109","AbstractTribesman","DoNothing,Move",0,"","","","","","1",<br />
'<!-- Abstract base npc type for tribes --><br />
<!-- [...] --><br />
<br />
<behavior name="test_loot" ><br />
<loot type="all"/><br />
</behavior><br />
<br />
<react event="test_loot" behavior="test_loot" /><br />
<!-- [...] --><br />
');</nowiki></code><br />
<br />
Reload the table:<br />
<br />
<code>mysql -u planeshift -pplaneshift planeshift<br />
<br />
mysql> source sc_npctypes.sql;</code><br />
<br />
On the psclient click on a NPC Hunter or Miner (has to be one of these due to "AbstractTribesman") and execute these commands:<br />
<br />
<code><br />
/debugnpc<br />
<br />
/percept test_loot test_loot</code><br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10129
HowTo Add a NPC Operation
2013-04-02T18:46:28Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in networkmgr<br />
# Modify npcmessages<br />
# Process Command in npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Test ==<br />
<br />
Create a behavior to test with:<br />
<br />
Add new <behavior> and <react event> to AbstractTribesman in sc_npctypes.sql and reload the table:<br />
<br />
<code><br />
<nowiki><br />
INSERT INTO sc_npctypes VALUES("109","AbstractTribesman","DoNothing,Move",0,"","","","","","1",<br />
'<!-- Abstract base npc type for tribes --><br />
<!-- [...] --><br />
<br />
<behavior name="test_loot" ><br />
<loot type="all"/><br />
</behavior><br />
<br />
<react event="test_loot" behavior="test_loot" /><br />
<!-- [...] --><br />
');</nowiki></code><br />
From client /percept ... test_loot to execute the function. Do /debug_npc first to monitor.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10128
HowTo Add a NPC Operation
2013-04-01T21:24:24Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in networkmgr<br />
# Modify npcmessages<br />
# Process Command in npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Test ==<br />
<br />
Create a behavior to test with:<br />
<br />
Add new <behavior> and <react event> to AbstractTribesman in sc_npctypes.sql and reload the table:<br />
<br />
<code><br />
<nowiki><br />
INSERT INTO sc_npctypes VALUES("109","AbstractTribesman","DoNothing,Move",0,"","","","","","1",<br />
'<!-- Abstract base npc type for tribes --><br />
<!-- [...] --><br />
<br />
<behavior "test_loot" ><br />
<loot type="all"/><br />
</behavior><br />
<br />
<react event="test_loot" behavior="test_loot" /><br />
<!-- [...] --><br />
');</nowiki></code><br />
From client /percept ... test_loot to execute the function. Do /debug_npc first to monitor.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10127
HowTo Add a NPC Operation
2013-04-01T20:45:28Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Test ==<br />
<br />
Create a behavior to test with:<br />
<br />
Add new <behavior> and <react event> to AbstractTribesman in sc_npctypes.sql and reload the table:<br />
<br />
<code><br />
<nowiki><br />
INSERT INTO sc_npctypes VALUES("109","AbstractTribesman","DoNothing,Move",0,"","","","","","1",<br />
'<!-- Abstract base npc type for tribes --><br />
<!-- [...] --><br />
<br />
<behavior "test_loot" ><br />
<loot type="all"/><br />
</behavior><br />
<br />
<react event="test_loot" behavior="test_loot" /><br />
<!-- [...] --><br />
');</nowiki></code><br />
From client /percept ... test_loot to execute the function. Do /debug_npc first to monitor.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10126
HowTo Add a NPC Operation
2013-04-01T20:08:18Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Test ==<br />
<br />
Create a behavior to test with:<br />
<br />
Adding this to abstract tribes man sc_npctypes.sql and reload the table:<br />
<br />
<code><br />
<nowiki><br />
<behavior "test_loot" /><br />
<loot type="all"/><br />
</behavior><br />
<br />
<react event="test_loot" behavior="test_loot" /></nowiki></code><br />
<br />
From client /percept ... test_loot to execute the function. Do /debug_npc first to monitor.<br />
<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10123
HowTo Add a NPC Operation
2013-04-01T17:40:55Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Add Operation to npcbehave<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== Add Operation to npcbehave ==<br />
Add new operation to Behavior::LoadScript():<br />
<br />
src/npcclient/npcbehave.cpp<br />
<code><br />
<nowiki><br />
bool Behavior::LoadScript(iDocumentNode *node,bool top_level)<br />
{<br />
// [...]<br />
else if ( strcmp( node->GetValue(), "loot" ) == 0 )<br />
{<br />
op = new LootOperation;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10122
HowTo Add a NPC Operation
2013-04-01T17:28:49Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all";<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type)<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10121
HowTo Add a NPC Operation
2013-04-01T17:15:41Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all"<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type);<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPCActor* npc = dynamic_cast<gemNPCActor*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10120
HowTo Add a NPC Operation
2013-04-01T17:12:34Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
== New Operation Class ==<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all"<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
== New Queue-Command ==<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type);<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
== Modify npcmessages ==<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
== Process Command ==<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPC* npc = dynamic_cast<gemNPC*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10119
HowTo Add a NPC Operation
2013-04-01T17:11:55Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
NOTE: In Work<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify common/net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
=== New Operation Class ===<br />
<br />
Example: LootOperation<br />
<br />
src/npcclient/npcoperations.h<br />
<br />
<code><br />
<nowiki><br />
/** Loot will make the NPC loot specified items<br />
*<br />
* This class is the implementation of the loot operations<br />
* used in behavior scripts for NPCS.<br />
*<br />
* Examples: <pre><br />
* \<loot type="all" /\><br />
* \<loot type="weapons" /\> </pre><br />
*/<br />
class LootOperation : public ScriptOperation<br />
{<br />
protected:<br />
csString type; ///< Type of items to loot<br />
<br />
public:<br />
<br />
LootOperation(): ScriptOperation("Loot") {};<br />
virtual ~LootOperation() {};<br />
virtual OperationResult Run(NPC* npc,bool interrupted);<br />
virtual bool Load(iDocumentNode* node);<br />
virtual ScriptOperation* MakeCopy();<br />
};</nowiki></code><br />
<br />
src/npcclient/npcoperations.cpp<br />
<code><br />
<nowiki><br />
bool LootOperation::Load(iDocumentNode *node)<br />
{<br />
type = node->GetAttributeValue("type");<br />
<br />
if(type.IsEmpty())<br />
type = "all"<br />
<br />
return true;<br />
}<br />
<br />
ScriptOperation* LootOperation::MakeCopy()<br />
{<br />
LootOperation* op = new LootOperation;<br />
<br />
op->type = type;<br />
<br />
return op;<br />
}<br />
<br />
ScriptOperation::OperationResult LootOperation::Run(NPC *npc, bool interrupted)<br />
{<br />
npcclient->GetNetworkMgr()->QueueLootCommand(npc->GetActor(), type);<br />
<br />
return OPERATION_COMPLETED; // Nothing more to do for this op.<br />
}</nowiki></code><br />
<br />
=== New Queue-Command ===<br />
src/npcclient/networkmgr.h<br />
<code><br />
<nowiki><br />
/**<br />
* Send a command to loot selected target.<br />
*/<br />
void QueueLootCommand(gemNPCActor *entity, const csString& type);</nowiki></code><br />
<br />
src/npcclient/networkmgr.cpp<br />
<code><br />
<nowiki><br />
void NetworkManager::QueueLootCommand(gemNPCActor *entity, const csString& type);<br />
{<br />
CheckCommandsOverrun(sizeof(uint8_t) + sizeof(uint32_t) + (type.Length()+1));<br />
<br />
outbound->msg->Add((int8_t) psNPCCommandsMessage::CMD_LOOT);<br />
outbound->msg->Add(entity->GetEID().Unbox());<br />
outbound->msg->Add(type);<br />
<br />
if(outbound->msg->overrun)<br />
{<br />
CS_ASSERT(!"NetworkManager::QueueLootCommand put message in overrun state!\n");<br />
}<br />
<br />
cmd_count++;<br />
}</nowiki></code><br />
<br />
=== Modify npcmessages ===<br />
<br />
Add new CMD to PerceptionType:<br />
<br />
src/common/net/npcmessages.h<br />
<code><br />
<nowiki><br />
enum PerceptionType<br />
{<br />
// Commands go from superclient to server<br />
// [...]<br />
CMD_CONTROL,<br />
CMD_LOOT, // new CMD for looting<br />
// Perceptions go from server to superclient<br />
PCPT_ANYRANGEPLAYER,<br />
// [...]<br />
};</nowiki></code><br />
<br />
Add new case to psNPCCOmmandsMessage::ToString():<br />
<br />
src/common/net/npcmessages.cpp<br />
<code><br />
<nowiki><br />
csString psNPCCommandsMessage::ToString(NetBase::AccessPointers * accessPointers)<br />
{<br />
// [...]<br />
<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
msgtext.Append("CMD_LOOT: ");<br />
<br />
// Extract the data<br />
EID entity_id = EID(msg->GetUInt32());<br />
csString type = msg->GetStr();<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT,msg->clientnum,"Received incomplete CMD_LOOT from NPC client %u.\n",msg->clientnum);<br />
break;<br />
}<br />
<br />
msgtext.AppendFmt("EID: %u Type: %s", entity_id.Unbox(), type.GetData());<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
=== Process Command ===<br />
Add case for new Command in NPCManager::HandleCommandList():<br />
<br />
src/npcclient/npcmanager.cpp<br />
<code><br />
<nowiki><br />
void NPCManager::HandleCommandList(MsgEntry* me,Client* client)<br />
{<br />
// [...]<br />
case psNPCCommandsMessage::CMD_LOOT:<br />
{<br />
EID entity_id = EID(list.msg->GetUInt32());<br />
csString type = list.msg->GetStr();<br />
Debug4(LOG_SUPERCLIENT, entity_id.Unbox(), "-->Got loot cmd: Entity %s to loot for %s\n",<br />
ShowID(entity_id), type.GetData());<br />
<br />
// Make sure we haven't run past the end of the buffer<br />
if(list.msg->overrun)<br />
{<br />
Debug2(LOG_SUPERCLIENT, entity_id.Unbox(), "Received incomplete CMD_LOOT from NPC client %u.\n", me->clientnum);<br />
break;<br />
}<br />
<br />
gemNPC* npc = dynamic_cast<gemNPC*>(gemSupervisor->FindObject(entity_id));<br />
<br />
/* NEEDED?<br />
psCharacter* chardata = NULL;<br />
<br />
if(npc) chardata = npc->GetCharacterData();<br />
<br />
if(!chardata)<br />
{<br />
Debug1(LOG_SUPERCLIENT, entity_id.Unbox(), "Couldn't find character data.\n");<br />
break;<br />
}*/<br />
<br />
if(npc)<br />
{<br />
psserver->GetUserManager()->LootMoney(client);<br />
psserver->GetUserManager()->LootItems(client, type);<br />
<br />
if(npc->GetTribeID())<br />
{<br />
// add loot to tribe's resources<br />
}<br />
}<br />
else<br />
Error1("NPC Client try to loot with no existing npc");<br />
<br />
break;<br />
}<br />
// [...]<br />
}</nowiki></code><br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10118
HowTo Add a NPC Operation
2013-04-01T15:05:50Z
<p>Naeg: </p>
<hr />
<div>== Summary ==<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Modify net/npcmessages<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=HowTo_Add_a_NPC_Operation&diff=10117
HowTo Add a NPC Operation
2013-04-01T15:03:39Z
<p>Naeg: Created page with "== Summary == # Create new Operation Class in npcclient/npcoperations # Create new Queue-Command in npcclient/networkmgr # Process Command in npcclient/npcmanager and execute..."</p>
<hr />
<div>== Summary ==<br />
<br />
# Create new Operation Class in npcclient/npcoperations<br />
# Create new Queue-Command in npcclient/networkmgr<br />
# Process Command in npcclient/npcmanager and execute desired action<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=NpcClient_Design&diff=10116
NpcClient Design
2013-04-01T14:58:08Z
<p>Naeg: </p>
<hr />
<div>== Classes ==<br />
<br />
The main classes of the NPCClient is the shown in the diagram below. <br />
<br />
<uml><br />
psNPCClient "1" *-- "1" NetworkManager : network<br />
psNPCClient "1" *-- "0..N" NPCType : npctypes<br />
psNPCClient "1" *-- "0..N" NPC : npcs<br />
NPCType "1" -left--* "1" NPC : brain<br />
psNPCClient "1" *-- "0..N" Tribe : tribes<br />
psNPCClient "1" *-- "0..N" gemNPCObject : all_gem_objects<br />
</uml><br />
<br />
For more details regarding these classes see the [[#Design|Design]] section.<br />
<br />
== Design ==<br />
<br />
*[[Network Design]]<br />
*[[NPCType Design]] (The NPC Brains)<br />
**[[NPC Perception Design]]<br />
**[[NPC ScriptOperation Design]]<br />
*[[Tribe Design]]<br />
*[[gemNPCObject Design]]<br />
<br />
<br />
*[[NpcClientStartup|On Start Up]]<br />
*[[NpcClientOnConnection|On Connection]]<br />
*[[NavMesh Design]]<br />
<br />
== Cases ==<br />
<br />
*[[NPC Life and Death]]<br />
<br />
== Documentation ==<br />
*[[CreateNPC|Create a NPC]] describes how to create a NPC.<br />
*[[NPC Scripting]] describes how to script NPCs.<br />
*[[Tribe Scripting]] describes how to script Tribes.<br />
<br />
== HowTo's ==<br />
<br />
* [[HowTo Add a NPC Operation]]<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=NpcClient_Design&diff=10115
NpcClient Design
2013-04-01T14:56:38Z
<p>Naeg: </p>
<hr />
<div>== Classes ==<br />
<br />
The main classes of the NPCClient is the shown in the diagram below. <br />
<br />
<uml><br />
psNPCClient "1" *-- "1" NetworkManager : network<br />
psNPCClient "1" *-- "0..N" NPCType : npctypes<br />
psNPCClient "1" *-- "0..N" NPC : npcs<br />
NPCType "1" -left--* "1" NPC : brain<br />
psNPCClient "1" *-- "0..N" Tribe : tribes<br />
psNPCClient "1" *-- "0..N" gemNPCObject : all_gem_objects<br />
</uml><br />
<br />
For more details regarding these classes see the [[#Design|Design]] section.<br />
<br />
== Design ==<br />
<br />
*[[Network Design]]<br />
*[[NPCType Design]] (The NPC Brains)<br />
**[[NPC Perception Design]]<br />
**[[NPC ScriptOperation Design]]<br />
*[[Tribe Design]]<br />
*[[gemNPCObject Design]]<br />
<br />
<br />
*[[NpcClientStartup|On Start Up]]<br />
*[[NpcClientOnConnection|On Connection]]<br />
*[[NavMesh Design]]<br />
<br />
== Cases ==<br />
<br />
*[[NPC Life and Death]]<br />
<br />
== Documentation ==<br />
*[[CreateNPC|Create a NPC]] describes how to create a NPC.<br />
*[[NPC Scripting]] describes how to script NPCs.<br />
*[[Tribe Scripting]] describes how to script Tribes.<br />
<br />
== Howtos ==<br />
<br />
* [[Howto Add a NPC Operation]]<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg
https://planeshift.top-ix.org//pswiki/index.php?title=NpcClient_Design&diff=10114
NpcClient Design
2013-04-01T14:55:23Z
<p>Naeg: </p>
<hr />
<div>== Classes ==<br />
<br />
The main classes of the NPCClient is the shown in the diagram below. <br />
<br />
<uml><br />
psNPCClient "1" *-- "1" NetworkManager : network<br />
psNPCClient "1" *-- "0..N" NPCType : npctypes<br />
psNPCClient "1" *-- "0..N" NPC : npcs<br />
NPCType "1" -left--* "1" NPC : brain<br />
psNPCClient "1" *-- "0..N" Tribe : tribes<br />
psNPCClient "1" *-- "0..N" gemNPCObject : all_gem_objects<br />
</uml><br />
<br />
For more details regarding these classes see the [[#Design|Design]] section.<br />
<br />
== Design ==<br />
<br />
*[[Network Design]]<br />
*[[NPCType Design]] (The NPC Brains)<br />
**[[NPC Perception Design]]<br />
**[[NPC ScriptOperation Design]]<br />
*[[Tribe Design]]<br />
*[[gemNPCObject Design]]<br />
<br />
<br />
*[[NpcClientStartup|On Start Up]]<br />
*[[NpcClientOnConnection|On Connection]]<br />
*[[NavMesh Design]]<br />
<br />
== Cases ==<br />
<br />
*[[NPC Life and Death]]<br />
<br />
== Documentation ==<br />
*[[CreateNPC|Create a NPC]] describes how to create a NPC.<br />
*[[NPC Scripting]] describes how to script NPCs.<br />
*[[Tribe Scripting]] describes how to script Tribes.<br />
<br />
== Howtos ==<br />
<br />
* [[Howto add a npc operation]]<br />
<br />
[[Category:Engine documents]] [[Category:NPCClient Design]]</div>
Naeg