Difference between revisions of "Plugin API"

From Mineserver Wiki
Jump to navigation Jump to search
{| class="wikitable"
{| class="wikitable"
−
|-
+
|- class="row0"
−
! Name
+
! class="col0" | Name
−
! Parameters
+
! class="col1" | Parameter name
−
! Return value
+
! class="col2" | Parameter type
−
|-
+
! class="col3" | Parameter info
−
| '''ChatPre'''
+
|- class="row1"
−
| const std::string& nick, std::string msg
+
| class="col0" rowspan="4" | '''ChatPre'''
−
| bool
+
| class="col1" | user
−
|-
+
| class="col2" | const char*
−
| colspan="3" | called on chat message prosessing, returning false will terminate the callback.
+
| class="col3" | Username in char array
−
|-
+
|- class="row2"
−
| '''BlockPlacePre'''
+
| class="col1" | userLen
−
| const std::string& nick, int x,char y,int z,char block
+
| class="col2" | size_t
−
| bool
+
| class="col3" | Length of username
−
|-
+
|- class="row4"
−
| colspan="3" | called on block placement, returning false will prevent block placement and terminate callback.
+
| class="col1" | msg
−
|-
+
| class="col2" | const char*
−
| '''BlockBreakPre'''
+
| class="col3" | Message in char array
−
| (int* x, int* y, int* z)
+
|- class="row5"
−
| bool
+
| class="col1" | msgLen
−
|-
+
| class="col2" | size_t
−
| colspan="3" | called on block break, returning false will prevent block breaking and terminate callback.
+
| class="col3" | Length of the message
 +
|- class="row6"
 +
! class="col0" | Return value
 +
| class="col1 rightalign" colspan="3" | bool
 +
|- class="row7"
 +
| class="col0" colspan="4" | called on chat message prosessing, returning false will terminate the callback.
|}
|}
 +
 +
{| class="wikitable"
 +
|- class="row0"
 +
! class="col0" | Name
 +
! class="col1" | Parameter name
 +
! class="col2" | Parameter type
 +
! class="col3" | Parameter info
 +
|- class="row1"
 +
| class="col0" rowspan="6" | '''BlockPlacePre'''
 +
| class="col1" | user
 +
| class="col2" | const char*
 +
| class="col3" | Username in char array
 +
|- class="row2"
 +
| class="col1" | userLen
 +
| class="col2" | size_t
 +
| class="col3" | Length of username
 +
|- class="row4"
 +
| class="col1" | x
 +
| class="col2" | int
 +
| class="col3" | x-coord
 +
|- class="row5"
 +
| class="col1" | y
 +
| class="col2" | int
 +
| class="col3" | y-coord
 +
|- class="row6"
 +
| class="col1" | z
 +
| class="col2" | int
 +
| class="col3" | z-coord
 +
|- class="row7"
 +
| class="col1" | block
 +
| class="col2" | char
 +
| class="col3" | block type
 +
|- class="row8"
 +
! class="col0" | Return value
 +
| class="col1 rightalign" colspan="3" | bool
 +
|- class="row9"
 +
| class="col0" colspan="4" | called on block placement, returning false will prevent block placement and terminate callback.
 +
|}
 +
 +
{| class="wikitable"
 +
|- class="row0"
 +
! class="col0" | Name
 +
! class="col1" | Parameter name
 +
! class="col2" | Parameter type
 +
! class="col3" | Parameter info
 +
|- class="row1"
 +
| class="col0" rowspan="5" | '''BlockBreakPre'''
 +
| class="col1" | user
 +
| class="col2" | const char*
 +
| class="col3" | Username in char array
 +
|- class="row2"
 +
| class="col1" | userLen
 +
| class="col2" | size_t
 +
| class="col3" | Length of username
 +
|- class="row4"
 +
| class="col1" | x
 +
| class="col2" | int
 +
| class="col3" | x-coord
 +
|- class="row5"
 +
| class="col1" | y
 +
| class="col2" | int
 +
| class="col3" | y-coord
 +
|- class="row6"
 +
| class="col1" | z
 +
| class="col2" | int
 +
| class="col3" | z-coord
 +
|- class="row8"
 +
! class="col0" | Return value
 +
| class="col1 rightalign" colspan="3" | bool
 +
|- class="row9"
 +
| class="col0" colspan="4" | called on block break, returning false will prevent block breaking and terminate callback.
 +
|}