|
1 | 1 | MCDRpost API--自定义 Handler |
2 | 2 | ============================ |
3 | 3 |
|
| 4 | +.. py:currentmodule:: mcdrpost.api |
| 5 | +
|
4 | 6 | 一般来说,MCDRpost已经能够适应大多数服务端,但是对于某些特殊情况(比如1.9版本) [#f1]_,MCDRpost可能无法满足需求, |
5 | 7 | 考虑到插件对 Minecraft 的兼容性,插件暴露了一定的 API 用于 Minecraft 一些特殊服务端的适配 |
6 | 8 |
|
7 | 9 | 核心 API 有: |
8 | 10 |
|
9 | 11 | - classes |
10 | | - - AbstractVersionHandler |
11 | | - - AbstractSoundPlayer |
12 | | - - DefaultVersionHandler |
13 | | - - NewSoundPlayer |
14 | | - - OldSoundPlayer |
| 12 | + - :class:`AbstractVersionHandler` |
| 13 | + - :class:`AbstractSoundPlayer` |
| 14 | + - :class:`DefaultVersionHandler` |
| 15 | + - :class:`NewSoundPlayer` |
| 16 | + - :class:`OldSoundPlayer` |
15 | 17 | - functions |
16 | | - - register_handler |
| 18 | + - :func:`register_handler` |
17 | 19 | - types |
18 | | - - Item |
19 | | - - Environment |
| 20 | + - :class:`Item` |
| 21 | + - :class:`Environment` |
20 | 22 | - constants |
21 | 23 | - OFFHAND_CODE |
22 | 24 |
|
23 | 25 | 你可以在导入的时候使用下面的方式: |
24 | 26 |
|
25 | | -.. code:: python |
| 27 | +.. code-block:: python |
26 | 28 |
|
27 | 29 | from mcdrpost.api import * |
28 | 30 |
|
29 | 31 | 当然如果不希望污染全局变量也可以这样: |
30 | 32 |
|
31 | | -.. code:: python |
| 33 | +.. code-block:: python |
32 | 34 |
|
33 | 35 | from mcdrpost import api as mp |
34 | 36 |
|
35 | 37 | 详细文档 |
36 | 38 | ********* |
37 | 39 |
|
| 40 | +处理器 |
| 41 | +-------- |
| 42 | + |
| 43 | +.. autoclass:: AbstractVersionHandler |
| 44 | +.. autoclass:: DefaultVersionHandler |
| 45 | +.. autofunction:: register_handler |
| 46 | + |
| 47 | +声音播放器 |
| 48 | +---------- |
| 49 | + |
| 50 | +.. autoclass:: AbstractSoundPlayer |
| 51 | +.. autoclass:: NewSoundPlayer |
| 52 | +.. autoclass:: OldSoundPlayer |
| 53 | + |
| 54 | +类型 |
| 55 | +-------- |
38 | 56 |
|
39 | | -.. autoclass:: mcdrpost.api.AbstractVersionHandler |
40 | | -.. autoclass:: mcdrpost.api.DefaultVersionHandler |
41 | | -.. autofunction:: mcdrpost.api.register_handler |
42 | | -.. autoclass:: mcdrpost.api.AbstractSoundPlayer |
43 | | -.. autoclass:: mcdrpost.api.NewSoundPlayer |
44 | | -.. autoclass:: mcdrpost.api.OldSoundPlayer |
45 | | -.. autoclass:: mcdrpost.api.Item |
46 | | -.. autoclass:: mcdrpost.api.Environment |
| 57 | +.. autoclass:: Item |
| 58 | +.. autoclass:: Environment |
47 | 59 |
|
48 | 60 | 示例 |
49 | 61 | ------- |
@@ -107,7 +119,7 @@ MCDRpost API--自定义 Handler |
107 | 119 |
|
108 | 120 | 如果是用多文件插件的话,你甚至不需要定义 ``on_load``, 只需要在入口点内定义 Handler 并注册就好 |
109 | 121 |
|
110 | | -example_handler/entry.py |
| 122 | +在 ``example_handler/entry.py`` 文件内 |
111 | 123 |
|
112 | 124 | .. code:: python |
113 | 125 |
|
@@ -148,4 +160,4 @@ example_handler/entry.py |
148 | 160 |
|
149 | 161 | .. rubric:: 脚注 |
150 | 162 |
|
151 | | -.. [#f1] 1.13 以前没有 ``/data`` 命令,要获取玩家物品需要在服务端安装插件,但 MCDR 主打的就是不修改服务端,所以本插件不考虑支持旧版 |
| 163 | +.. [#f1] 1.13 以前没有 ``/data`` 命令,要获取玩家物品需要在服务端安装插件,但 MCDR 主打的就是不修改服务端,所以本插件不考虑主动支持旧版 |
0 commit comments