Difference between revisions of "Plugin API"

From Mineserver Wiki
Jump to navigation Jump to search
====Chat====
====Chat====
 +
{{APIFunct2|sendmsgTo|user|const char*|Username in null Terminated char array|msg|const char*|Message in null terminated char array|bool, telling it the user was found|Sends a message to specified ''user''}}
−
{| class="wikitable"
+
{{APIFunct1|sendmsg|msg|const char*|Message in null terminated char array|bool, telling it the user was found|Sends a message to all players, except they are in DND mode}}
−
|- class="row0"
 
−
! class="col0" | Function
 
−
! class="col1" | Parameter name
 
−
! class="col2" | Parameter type
 
−
! class="col3" | Parameter info
 
−
|- class="row1"
 
−
| class="col0" rowspan="2" | '''sendmsgTo'''
 
−
| class="col1" | user
 
−
| class="col2" | const char*
 
−
| class="col3" | Username in null terminated char array
 
−
|- class="row2"
 
−
| class="col1" | msg
 
−
| class="col2" | const char*
 
−
| class="col3" | Message in null terminated char array
 
−
|- class="row3"
 
−
! class="col0" | Return value
 
−
| class="col1 rightalign" colspan="3" | bool, telling it the user was found
 
−
|}
 
−
{| class="wikitable"
+
{{APIFunct1|sendUserList|user|const char*|User in null terminated char array|bool, telling it the user was found|Sends the playerlist to ''user''}}
−
|- class="row0"
 
−
! class="col0" | Function
 
−
! class="col1" | Parameter name
 
−
! class="col2" | Parameter type
 
−
! class="col3" | Parameter info
 
−
|- class="row1"
 
−
| class="col0" rowspan="1" | '''sendmsg'''
 
−
| class="col1" | msg
 
−
| class="col2" | const char*
 
−
| class="col3" | Message in null terminated char array
 
−
|- class="row2"
 
−
! class="col0" | Return value
 
−
| class="col1 rightalign" colspan="3" | bool, telling it the user was found
 
−
|}
 
====Screen====
====Screen====
−
{| class="wikitable"
+
{{APIFunctVoid|log|msg|const char*|Message in null terminated char array|Prints message to server window}}
−
|- class="row0"
 
−
! class="col0" | Function
 
−
! class="col1" | Parameter name
 
−
! class="col2" | Parameter type
 
−
! class="col3" | Parameter info
 
−
|- class="row1"
 
−
| class="col0" rowspan="1" | '''log'''
 
−
| class="col1" | msg
 
−
| class="col2" | const char*
 
−
| class="col3" | Message in null terminated char array
 
−
|- class="row2"
 
−
! class="col0" | Return value
 
−
| class="col1 rightalign" colspan="3" | void
 
−
|- class="row3"
 
−
| class="col0" colspan="4" | Prints message to server window
 
−
|}
 
====Map====
====Map====
 
| class="col1 rightalign" colspan="3" | bool
| class="col1 rightalign" colspan="3" | bool
|- class="row7"
|- class="row7"
−
| class="col0" colspan="4" | Get block type and metadata (absolute block coordinates)
+
| class="col0" colspan="4" | Get block type and metadata (absolute block coordinates) in first world (id 0)
|}
|}
 
! class="col3" | Parameter info
! class="col3" | Parameter info
|- class="row1"
|- class="row1"
 +
| class="col0" rowspan="6" | '''getBlockW'''
 +
| class="col1" | x
 +
| class="col2" | int
 +
| class="col3" | x-coordinate
 +
|- class="row2"
 +
| class="col1" | y
 +
| class="col2" | int
 +
| class="col3" | y-coordinate
 +
|- class="row3"
 +
| class="col1" | z
 +
| class="col2" | int
 +
| class="col3" | z-coordinate
 +
|- class="row4"
 +
| class="col1" | w
 +
| class="col2" | int
 +
| class="col3" | World ID
 +
|- class="row5"
 +
| class="col1" | type
 +
| class="col2" | unsigned char*
 +
| class="col3" | block type
 +
|- class="row6"
 +
| class="col1" | meta
 +
| class="col2" | unsigned char*
 +
| class="col3" | block metadata
 +
|- class="row7"
 +
! class="col0" | Return value
 +
| class="col1 rightalign" colspan="3" | bool
 +
|- class="row8"
 +
| class="col0" colspan="4" | Gets block type and metadata (absolute block coordinates)
 +
|}
 +
 +
{| class="wikitable"
 +
|- class="row0"
 +
! class="col0" | Function
 +
! class="col1" | Parameter name
 +
! class="col2" | Parameter type
 +
! class="col3" | Parameter info
 +
|- class="row1"
| class="col0" rowspan="5" | '''setBlock'''
| class="col0" rowspan="5" | '''setBlock'''
| class="col1" | x
| class="col1" | x
 
|}
|}
 +
{| class="wikitable"
 +
|- class="row0"
 +
! class="col0" | Function
 +
! class="col1" | Parameter name
 +
! class="col2" | Parameter type
 +
! class="col3" | Parameter info
 +
|- class="row1"
 +
| class="col0" rowspan="6" | '''setBlockW'''
 +
| class="col1" | x
 +
| class="col2" | int
 +
| class="col3" | x-coordinate
 +
|- class="row2"
 +
| class="col1" | y
 +
| class="col2" | int
 +
| class="col3" | y-coordinate
 +
|- class="row3"
 +
| class="col1" | z
 +
| class="col2" | int
 +
| class="col3" | z-coordinate
 +
|- class="row4"
 +
| class="col1" | w
 +
| class="col2" | int
 +
| class="col3" | World ID
 +
|- class="row5"
 +
| class="col1" | type
 +
| class="col2" | unsigned char*
 +
| class="col3" | block type
 +
|- class="row6"
 +
| class="col1" | meta
 +
| class="col2" | unsigned char*
 +
| class="col3" | block metadata
 +
|- class="row7"
 +
! class="col0" | Return value
 +
| class="col1 rightalign" colspan="3" | bool
 +
|- class="row8"
 +
| class="col0" colspan="4" | Sets block type and metadata (absolute block coordinates)
 +
|}
 +
 +
{| class="wikitable"
 +
|- class="row0"
 +
! class="col0" | Function
 +
! class="col1" | Parameter name
 +
! class="col2" | Parameter type
 +
! class="col3" | Parameter info
 +
|- class="row1"
 +
| class="col0" rowspan="5" | '''setSpawn'''
 +
| class="col1" | x
 +
| class="col2" | int
 +
| class="col3" | x-coordinate
 +
|- class="row2"
 +
| class="col1" | y
 +
| class="col2" | int
 +
| class="col3" | y-coordinate
 +
|- class="row3"
 +
| class="col1" | z
 +
| class="col2" | int
 +
| class="col3" | z-coordinate
 +
|- class="row4"
 +
! class="col0" | Return value
 +
| class="col1 rightalign" colspan="3" | bool
 +
|- class="row5"
 +
| class="col0" colspan="4" | Set spawn to x, y, z (absolute coordinates)
 +
|}
 +
==Available callbacks==
==Available callbacks==