Difference between revisions of "Plugin API"

From Mineserver Wiki
Jump to navigation Jump to search
  {
  {
    mineserver = mineserver_temp;
    mineserver = mineserver_temp;
−
if (mineserver->plugin.getPluginVersion(pluginName.c_str(),pluginName.size()) > 0)
+
if (mineserver->plugin.getPluginVersion(pluginName.c_str()) > 0)
    {
    {
−
std::string msg="command is already loaded v." +dtos(mineserver->plugin.getPluginVersion(pluginName.c_str(),pluginName.size()));
+
std::string msg="command is already loaded v." +dtos(mineserver->plugin.getPluginVersion(pluginName.c_str()));
      mineserver->screen.log(msg.c_str(),msg.size());
      mineserver->screen.log(msg.c_str(),msg.size());
      return;
      return;
    }
    }
    std::string msg="Loaded "+pluginName+"!";
    std::string msg="Loaded "+pluginName+"!";
−
mineserver->screen.log(msg.c_str(),msg.size());
+
mineserver->screen.log(msg.c_str());
−
mineserver->plugin.setPluginVersion(pluginName.c_str(),pluginName.size(), PLUGIN_COMMAND_VERSION);
+
mineserver->plugin.setPluginVersion(pluginName.c_str(), PLUGIN_COMMAND_VERSION);
−
std::string hookName="ChatPre";
+
mineserver->callback.add_hook("ChatPre", (void *)SOMEFUNCTIONNAME);
−
mineserver->callback.add_hook(hookName.c_str(),hookName.size(), (void *)SOMEFUNCTIONNAME);
+
mineserver->callback.add_hook("BlockPlacePre", (void *)SOMEFUNCTIONNAME2);
−
    hookName = "BlockPlacePre";
 
−
    mineserver->callback.add_hook(hookName.c_str(),hookName.size(), (void *)SOMEFUNCTIONNAME2);
 
  }
  }
  PLUGIN_API_EXPORT void (plugin_name)_shutdown(void)
  PLUGIN_API_EXPORT void (plugin_name)_shutdown(void)
  {
  {
−
if (mineserver->plugin.getPluginVersion(pluginName.c_str(),pluginName.size()) <= 0)
+
if (mineserver->plugin.getPluginVersion(pluginName.c_str()) <= 0)
    {
    {
−
std::string msg="command is not loaded!";
+
mineserver->screen.log("command is not loaded!"));
−
      mineserver->screen.log(msg.c_str(),msg.size());
 
      return;
      return;
    }
    }
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="4" | '''sendmsgTo'''
+
| class="col0" rowspan="2" | '''sendmsgTo'''
| class="col1" | user
| class="col1" | user
| class="col2" | const char*
| class="col2" | const char*
−
| class="col3" | Username in char array
+
| class="col3" | Username in null terminated char array
|- class="row2"
|- class="row2"
−
| class="col1" | userLen
 
−
| class="col2" | size_t
 
−
| class="col3" | Length of username
 
−
|- class="row4"
 
| class="col1" | msg
| class="col1" | msg
| class="col2" | const char*
| class="col2" | const char*
−
| class="col3" | Message in char array
+
| class="col3" | Message in null terminated char array
−
|- class="row5"
+
|- class="row3"
−
| class="col1" | msgLen
 
−
| class="col2" | size_t
 
−
| class="col3" | length of the message
 
−
|- class="row6"
 
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | bool, telling it the user was found
| class="col1 rightalign" colspan="3" | bool, telling it the user was found
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="2" | '''sendmsg'''
+
| class="col0" rowspan="1" | '''sendmsg'''
| class="col1" | msg
| class="col1" | msg
| class="col2" | const char*
| class="col2" | const char*
−
| class="col3" | Message in char array
+
| class="col3" | Message in null terminated char array
|- class="row2"
|- class="row2"
−
| class="col1" | msgLen
 
−
| class="col2" | size_t
 
−
| class="col3" | length of the message
 
−
|- class="row3"
 
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | bool, telling it the user was found
| class="col1 rightalign" colspan="3" | bool, telling it the user was found
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="2" | '''log'''
+
| class="col0" rowspan="1" | '''log'''
| class="col1" | msg
| class="col1" | msg
| class="col2" | const char*
| class="col2" | const char*
−
| class="col3" | Message in char array
+
| class="col3" | Message in null terminated char array
|- class="row2"
|- class="row2"
−
| class="col1" | msgLen
 
−
| class="col2" | size_t
 
−
| class="col3" | length of the message
 
−
|- class="row3"
 
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | void
| class="col1 rightalign" colspan="3" | void
−
|- class="row8"
+
|- class="row3"
| class="col0" colspan="4" | Prints message to server window
| class="col0" colspan="4" | Prints message to server window
|}
|}
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="7" | '''createPickupSpawn'''
+
| class="col0" rowspan="6" | '''createPickupSpawn'''
| class="col1" | x
| class="col1" | x
| class="col2" | int
| class="col2" | int
 
| class="col3" | Username
| class="col3" | Username
|- class="row6"
|- class="row6"
−
| class="col1" | userLen
 
−
| class="col2" | size_t
 
−
| class="col3" | Length of username
 
−
|- class="row7"
 
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | void
| class="col1 rightalign" colspan="3" | void
−
|- class="row8"
+
|- class="row7"
| class="col0" colspan="4" | Spawns an item at (x,y,z) with type,count and health specified. If "user" is set, he will not be able to pick up the item right away to make it possible to throw stuff away.
| class="col0" colspan="4" | Spawns an item at (x,y,z) with type,count and health specified. If "user" is set, he will not be able to pick up the item right away to make it possible to throw stuff away.
|}
|}
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="4" | '''ChatPre'''
+
| class="col0" rowspan="2" | '''ChatPre'''
| class="col1" | user
| class="col1" | user
| class="col2" | const char*
| class="col2" | const char*
−
| class="col3" | Username in char array
+
| class="col3" | Username in null terminated char array
|- class="row2"
|- class="row2"
−
| class="col1" | userLen
 
−
| class="col2" | size_t
 
−
| class="col3" | Length of username
 
−
|- class="row4"
 
| class="col1" | msg
| class="col1" | msg
| class="col2" | const char*
| class="col2" | const char*
−
| class="col3" | Message in char array
+
| class="col3" | Message in null terminated char array
−
|- class="row5"
+
|- class="row3"
−
| class="col1" | msgLen
 
−
| class="col2" | size_t
 
−
| class="col3" | Length of the message
 
−
|- class="row6"
 
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | bool
| class="col1 rightalign" colspan="3" | bool
−
|- class="row7"
+
|- class="row4"
| class="col0" colspan="4" | called on chat message prosessing, returning false will terminate the callback.
| class="col0" colspan="4" | called on chat message prosessing, returning false will terminate the callback.
|}
|}
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="6" | '''BlockPlacePre'''
+
| class="col0" rowspan="5" | '''BlockPlacePre'''
| class="col1" | user
| class="col1" | user
| class="col2" | const char*
| class="col2" | const char*
| class="col3" | Username in char array
| class="col3" | Username in char array
|- class="row2"
|- class="row2"
−
| class="col1" | userLen
 
−
| class="col2" | size_t
 
−
| class="col3" | Length of username
 
−
|- class="row4"
 
| class="col1" | x
| class="col1" | x
| class="col2" | int
| class="col2" | int
| class="col3" | x-coord
| class="col3" | x-coord
−
|- class="row5"
+
|- class="row3"
| class="col1" | y
| class="col1" | y
| class="col2" | int
| class="col2" | int
| class="col3" | y-coord
| class="col3" | y-coord
−
|- class="row6"
+
|- class="row4"
| class="col1" | z
| class="col1" | z
| class="col2" | int
| class="col2" | int
| class="col3" | z-coord
| class="col3" | z-coord
−
|- class="row7"
+
|- class="row5"
| class="col1" | block
| class="col1" | block
| class="col2" | char
| class="col2" | char
| class="col3" | block type
| class="col3" | block type
−
|- class="row8"
+
|- class="row6"
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | bool
| class="col1 rightalign" colspan="3" | bool
−
|- class="row9"
+
|- class="row7"
| class="col0" colspan="4" | called on block placement, returning false will prevent block placement and terminate callback.
| class="col0" colspan="4" | called on block placement, returning false will prevent block placement and terminate callback.
|}
|}
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
−
| class="col0" rowspan="5" | '''BlockBreakPre'''
+
| class="col0" rowspan="4" | '''BlockBreakPre'''
| class="col1" | user
| class="col1" | user
| class="col2" | const char*
| class="col2" | const char*
| class="col3" | Username in char array
| class="col3" | Username in char array
|- class="row2"
|- class="row2"
−
| class="col1" | userLen
 
−
| class="col2" | size_t
 
−
| class="col3" | Length of username
 
−
|- class="row4"
 
| class="col1" | x
| class="col1" | x
| class="col2" | int
| class="col2" | int
| class="col3" | x-coord
| class="col3" | x-coord
−
|- class="row5"
+
|- class="row3"
| class="col1" | y
| class="col1" | y
| class="col2" | int
| class="col2" | int
| class="col3" | y-coord
| class="col3" | y-coord
−
|- class="row6"
+
|- class="row4"
| class="col1" | z
| class="col1" | z
| class="col2" | int
| class="col2" | int
| class="col3" | z-coord
| class="col3" | z-coord
−
|- class="row8"
+
|- class="row5"
! class="col0" | Return value
! class="col0" | Return value
| class="col1 rightalign" colspan="3" | bool
| class="col1 rightalign" colspan="3" | bool
−
|- class="row9"
+
|- class="row6"
| class="col0" colspan="4" | called on block break, returning false will prevent block breaking and terminate callback.
| class="col0" colspan="4" | called on block break, returning false will prevent block breaking and terminate callback.
|}
|}