summaryrefslogtreecommitdiff
path: root/src/plugins/sample.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/sample.c')
-rw-r--r--src/plugins/sample.c61
1 files changed, 40 insertions, 21 deletions
diff --git a/src/plugins/sample.c b/src/plugins/sample.c
index d1a95c71d..750ab31f9 100644
--- a/src/plugins/sample.c
+++ b/src/plugins/sample.c
@@ -14,6 +14,8 @@
#include "../map/pc.h"
#include "../map/clif.h"
+#include "../common/HPMDataCheck.h" /* should always be the last file included! (if you don't make it last, it'll intentionally break compile time) */
+
HPExport struct hplugin_info pinfo = {
"Sample", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
@@ -36,6 +38,7 @@ struct sample_data_struct {
struct point lastMSGPosition;
unsigned int someNumber;
};
+
/* sample packet implementation */
/* cmd 0xf3 - it is a client-server existent id, for clif_parse_GlobalMessage */
/* in this sample we do nothing and simply redirect */
@@ -48,7 +51,7 @@ void sample_packet0f3(int fd) {
ShowInfo("sample_packet0f3: Hello World! received 0xf3 for '%s', redirecting!\n",sd->status.name);
/* sample usage of appending data to a socket_data (session[]) entry */
- if( !(data = HPMi->getFromSession(session[fd],HPMi->pid,0)) ) {
+ if( !(data = getFromSession(session[fd],0)) ) {
CREATE(data,struct sample_data_struct,1);
data->lastMSGPosition.map = sd->status.last_point.map;
@@ -57,17 +60,17 @@ void sample_packet0f3(int fd) {
data->someNumber = rand()%777;
ShowInfo("Created Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
- HPMi->addToSession(session[fd],data,HPMi->pid,0,true);
+ addToSession(session[fd],data,0,true);
} else {
ShowInfo("Existent Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
if( rand()%4 == 2 ) {
ShowInfo("Removing Appended session[] data\n");
- HPMi->removeFromSession(session[fd],HPMi->pid,0);
+ removeFromSession(session[fd],0);
}
}
/* sample usage of appending data to a map_session_data (sd) entry */
- if( !(data = HPMi->getFromMSD(sd,HPMi->pid,0)) ) {
+ if( !(data = getFromMSD(sd,0)) ) {
CREATE(data,struct sample_data_struct,1);
data->lastMSGPosition.map = sd->status.last_point.map;
@@ -76,12 +79,12 @@ void sample_packet0f3(int fd) {
data->someNumber = rand()%777;
ShowInfo("Created Appended map_session_data data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
- HPMi->addToMSD(sd,data,HPMi->pid,0,true);
+ addToMSD(sd,data,0,true);
} else {
ShowInfo("Existent Appended map_session_data data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
if( rand()%4 == 2 ) {
ShowInfo("Removing Appended map_session_data data\n");
- HPMi->removeFromMSD(sd,HPMi->pid,0);
+ removeFromMSD(sd,0);
}
}
@@ -108,6 +111,10 @@ int my_pc_dropitem_post(int retVal, struct map_session_data *sd,int *n,int *amou
}
return 1;
}
+void parse_my_setting(const char *val) {
+ ShowDebug("Received 'my_setting:%s'\n",val);
+ /* do anything with the var e.g. config_switch(val) */
+}
/* run when server starts */
HPExport void plugin_init (void) {
char *server_type;
@@ -124,7 +131,7 @@ HPExport void plugin_init (void) {
script = GET_SYMBOL("script");
clif = GET_SYMBOL("clif");
pc = GET_SYMBOL("pc");
-
+
/* session[] */
session = GET_SYMBOL("session");
@@ -138,31 +145,43 @@ HPExport void plugin_init (void) {
ShowInfo ("I'm being run from the '%s' filename\n", server_name);
- if( HPMi->addCommand != NULL ) {//link our '@sample' command
- HPMi->addCommand("sample",ACMD_A(sample));
- }
+ /* addAtcommand("command-key",command-function) tells map server to call ACMD(sample) when "sample" command is used */
+ /* - it will print a warning when used on a non-map-server plugin */
+ addAtcommand("sample",sample);//link our '@sample' command
- if( HPMi->addScript != NULL ) {//link our 'sample' script command
- HPMi->addScript("sample","i",BUILDIN_A(sample));
- }
+ /* addScriptCommand("script-command-name","script-command-params-info",script-function) tells map server to call BUILDIN(sample) for the "sample(i)" command */
+ /* - it will print a warning when used on a non-map-server plugin */
+ addScriptCommand("sample","i",sample);
- if( HPMi->addCPCommand != NULL ) {//link our 'sample' console command
- HPMi->addCPCommand("this:is:a:sample",CPCMD_A(sample));
- }
-
- if( HPMi->addPacket != NULL ) {//link our 'sample' packet to map-server
- HPMi->addPacket(0xf3,-1,sample_packet0f3,hpClif_Parse,HPMi->pid);
- }
+ /* addCPCommand("console-command-name",command-function) tells server to call CPCMD(sample) for the 'this is a sample <optional-args>' console call */
+ /* in "console-command-name" usage of ':' indicates a category, for example 'this:is:a:sample' translates to 'this is a sample',
+ * therefore 'this -> is -> a -> sample', it can be used to aggregate multiple commands under the same category or to append commands to existing categories
+ * categories inherit the special keyword 'help' which prints the subsequent commands, e.g. 'server help' prints all categories and commands under 'server'
+ * therefore 'this help' would inform about 'is (category) -> a (category) -> sample (command)'*/
+ addCPCommand("this:is:a:sample",sample);
+ /* addPacket(packetID,packetLength,packetFunction,packetIncomingPoint) */
+ /* adds packetID of packetLength (-1 for dynamic length where length is defined in the packet { packetID (2 Byte) , packetLength (2 Byte) , ... })
+ * to trigger packetFunction in the packetIncomingPoint section ( available points listed in enum HPluginPacketHookingPoints within src/common/HPMi.h ) */
+ addPacket(0xf3,-1,sample_packet0f3,hpClif_Parse);
+
/* in this sample we add a PreHook to pc->dropitem */
/* to identify whether the item being dropped is on amount higher than 1 */
/* if so, it stores the amount on a variable (my_pc_dropitem_storage) and changes the amount to 1 */
addHookPre("pc->dropitem",my_pc_dropitem_pre);
+
/* in this sample we add a PostHook to pc->dropitem */
/* if the original pc->dropitem was successful and the amount stored on my_pc_dropitem_storage is higher than 1, */
/* our posthook will display a message to the user about the cap */
/* - by checking whether it was successful (retVal value) it allows for the originals conditions to take place */
- addHookPost("pc->dropitem",my_pc_dropitem_post);
+ addHookPost("pc->dropitem",my_pc_dropitem_post);
+}
+/* triggered when server starts loading, before any server-specific data is set */
+HPExport void server_preinit (void) {
+ /* makes map server listen to mysetting:value in any "battleconf" file (including imported or custom ones) */
+ /* value is not limited to numbers, its passed to our plugins handler (parse_my_setting) as const char *,
+ * and thus can be manipulated at will */
+ addBattleConf("my_setting",parse_my_setting);
}
/* run when server is ready (online) */
HPExport void server_online (void) {
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2025-04-30 16:45:45 +0000