Minecraft China Edition Developer Documentation

https://mc.163.com/dev/
Admin
Minecraft China Edition Developer Documentation provides comprehensive guides and API references for...
Tokens:5,811,036
Snippets:30,147
Trust Score:9.9
Update:6 days ago
Show doc for...
Tokens:
Raw
### GetSystem Client Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/System.html?catalog=1

Shows how to retrieve another client system instance from within a custom client system class.

```python
import mod.client.extraClientApi as clientApi
ClientSystem = clientApi.GetClientSystemCls()
class FpsClientSystem(ClientSystem):
    def __init__(self, namespace, systemName):
        ClientSystem.__init__(self, namespace, systemName)
        self.tutorialSystem = clientApi.GetSystem("TutorialMod", "TutorialClientSystem")

```

--------------------------------

### Get Query Variable Example (Python)

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E5%AE%9E%E4%BD%93/molang.html

Client-side example of getting a query variable value using QueryVariableComponentClient. The variable name must start with 'query.mod.' and must be registered via the Register interface before use.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateQueryVariable(entityId)
result = comp.Get('query.mod.state')

```

--------------------------------

### GetBlockEntityMolangValue example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E6%96%B9%E5%9D%97/%E6%96%B9%E5%9D%97%E5%AE%9E%E4%BD%93.html

Gets the value of a Molang variable from a custom block entity. The variable name must start with 'variable.' and contain no more than two dots.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateBlockInfo(levelId)
comp.GetBlockEntityMolangValue(pos, "query.mod.idle")
```

--------------------------------

### GetSystem Server Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/System.html?catalog=1

Shows how to retrieve a registered server system using its namespace and system name.

```python
import mod.server.extraServerApi as serverApi
serverSystem = serverApi.GetSystem("TutorialMod", "TutorialServerSystem")

```

--------------------------------

### RegisterSystem Client Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/System.html?catalog=1

Shows how to register a client system in the mod initialization method, using the @Mod.InitClient() decorator.

```python
import mod.client.extraClientApi as clientApi
# 系统system的注册是在modMain.py的MOD类中
# 客户端系统system的注册方式
@Mod.InitClient()
def TutorialClientInit(self):
    clientApi.RegisterSystem("TutorialMod", "TutorialClientSystem", "tutorialScripts.tutorialClientSystem.TutorialClientSystem")

```

--------------------------------

### StartChunkProfile example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/2-Apollo/4-SDK/6-%E5%A4%A7%E5%8E%85%E4%B8%8E%E6%B8%B8%E6%88%8F%E6%9C%8DAPI.html?catalog=1

Starts server-side chunk read/write performance profiling. Call StopChunkProfile to get the profiling info; note that enabling this has significant overhead and is not recommended for long-term use.

```python
import lobbyGame.netgameApi as lobbyGameApi
suc = lobbyGameApi.StartChunkProfile()
print "StartChunkProfile suc={}".format(suc)
```

--------------------------------

### GetServerSystemCls Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/System.html?catalog=1

Shows how to get the server system base class and define a custom server system by inheriting from it.

```python
import mod.server.extraServerApi as serverApi
ServerSystem = serverApi.GetServerSystemCls()
class FpsServerSystem(ServerSystem):
    def __init__(self, namespace, systemName):
        ServerSystem.__init__(self, namespace, systemName)

```

--------------------------------

### GetEntityRider - Client Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%8E%A9%E5%AE%B6/%E8%A1%8C%E4%B8%BA.html

Client-side example to get the entity id that the rider is riding. Returns '-1' if not riding.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateRide(entityId)
riderId = comp.GetEntityRider()
```

--------------------------------

### RegisterSystem Server Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/System.html?catalog=1

Shows how to register a server system in the mod initialization method, using the @Mod.InitServer() decorator.

```python
import mod.server.extraServerApi as serverApi
# 系统system的注册是在modMain.py的MOD类中
# 服务端系统system的注册方式
@Mod.InitServer()
def TutorialServerInit(self):
    serverApi.RegisterSystem("TutorialMod", "TutorialServerSystem", "tutorialScripts.tutorialServerSystem.TutorialServerSystem")

```

--------------------------------

### GetEntityRider - Server Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%8E%A9%E5%AE%B6/%E8%A1%8C%E4%B8%BA.html

Server-side example to get the entity id that the rider is riding. Returns '-1' if not riding.

```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreateRide(entityId)
riderId = comp.GetEntityRider()
```

--------------------------------

### GetItemDefenceAngle example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%89%A9%E5%93%81.html

Python example showing how to get the shield's defense angle range from the server-side item component.

```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreateItem(playerId)
comp.GetItemDefenceAngle(serverApi.GetMinecraftEnum().ItemPosType.INVENTORY, 0)
```

--------------------------------

### GetClientSystemCls Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/System.html?catalog=1

Shows how to get the client system base class and define a custom client system by inheriting from it.

```python
import mod.client.extraClientApi as clientApi
ClientSystem = clientApi.GetClientSystemCls()
class FpsClientSystem(ClientSystem):
    def __init__(self, namespace, systemName):
        ClientSystem.__init__(self, namespace, systemName)

```

--------------------------------

### CameraStopActions example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E8%99%9A%E6%8B%9F%E4%B8%96%E7%95%8C/%E7%9B%B8%E6%9C%BA.html

Stops the camera movement animation. The example first starts a camera move with CameraMoveTo, then stops it with CameraStopActions.

```python
import client.extraClientApi as clientApi
virtualWorldComp = clientApi.GetEngineCompFactory().CreateVirtualWorld(clientApi.GetLevelId())
virtualWorldComp.CameraMoveTo((0.0, 0.0, -10.0), (1.0, 1.0, -10.0), (0.0,1.0, 0.0), 1.0, 3.0, clientApi.GetMinecraftEnum().TimeEaseType.linear)
virtualWorldComp.CameraStopActions()

```

--------------------------------

### Complete readme.txt example for guild plugin

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcguide/27-%E6%89%8B%E6%9C%BA%E7%BD%91%E7%BB%9C%E6%B8%B8%E6%88%8F/%E8%AF%BE%E7%A8%8B5%EF%BC%9A%E6%8F%92%E4%BB%B6%E6%95%99%E5%AD%A6/%E7%AC%AC1%E8%8A%82%EF%BC%9A%E5%AE%98%E7%BD%91%E6%8F%92%E4%BB%B6%E8%A7%84%E8%8C%83.html?catalog=1

Complete readme.txt example for a guild plugin. Shows the required sections: plugin introduction, composition, usage steps, API documentation with a Python example, event documentation with a Python listener example, operational command documentation, and update log.

```text
插件介绍：这是个公会插件

插件构成：
（1）lovecraftGuild: 部署于大厅服或游戏服。
（2）lovecraftGuildMaster: 部署于控制服。
（3）lovecraftGuildService: 部署于功能服。

使用步骤：
1、请在mysql中执行mod.sql
2、配置mod.json，请按照文件mod.json中"_comment"注释配置对应内容。
3、MCStudio把lovecraftGuild添加到大厅服或游戏服。
4、MCStudio把lovecraftGuildMaster添加到控制服。
5、MCStudio把lovecraftGuildService添加到功能服。

插件api：
（1）获取玩家昵称api
适用范围：大厅服/游戏服
函数：GetNickname(uid)
参数：
    uid: int，玩家id
返回：
    string，玩家的昵称
示例：
    import server.extraServerApi as serverApi
    system = serverApi.GetSystem("lovecraftGuild", "lovecraftGuildDev")
    system.GetNickname(123)#获取玩家的昵称

插件event：
（1）GuildEvent
适用范围：大厅服/游戏服
命名空间：namespace = 'lovecraftGuild', systemname = 'lovecraftGuildDev'
描述：测试的event
参数：
    uid: int,玩家id
    nickname: str,玩家昵称
示例：
    def __init__(self, namespace, systemName):
        self.ListenForEvent('lovecraftGuild', 'lovecraftGuildDev', 'GuildEvent', self, self.OnGuildEvent)

    def OnGuildEvent(self, data):
        uid = data['uid']
        nickname = data['nickname']

运营指令：
（1）test指令
post url: http:masterip:masterport/test
post body:{
    "uid" : 123#玩家id
}
response:
 {
     "code": 1,
     "entity": {
         "name": "player_name" #玩家昵称
       },
       "message": ""
 }

更新列表：
1.0.1版本：
新增指令/test

```

--------------------------------

### GetInteracteCenterOffset - Server Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%8E%A9%E5%AE%B6/%E8%A1%8C%E4%B8%BA.html

Server-side example to get the player's interaction center offset, which corresponds to the value set by SetPickCenterOffset.

```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreatePlayer(playerId)
comp.GetInteracteCenterOffset()
```

--------------------------------

### BeginSprinting - Client-side Python Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%8E%A9%E5%AE%B6/%E8%A1%8C%E4%B8%BA.html

Makes the local player start and maintain forward sprinting. No parameters or return values. Uses the ActorMotionComponentClient.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateActorMotion(localPlayerId)
comp.BeginSprinting()

```

--------------------------------

### GetItemBasicInfo example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%89%A9%E5%93%81.html

Python example showing how to get basic item info for a bow and check if it supports the sword enchantment slot.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateItem(levelId)
info = comp.GetItemBasicInfo("minecraft:bow")
enchant_slot_type = info["enchant_slot_type"]
support_sword = (enchant_slot_type & EnchantSlotType.SWORD) > 0
```

--------------------------------

### Client-side StartCoroutine example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/%E5%B7%A5%E5%85%B7.html

Shows how to start a coroutine on the client using clientApi.StartCoroutine. Includes examples for both passing a generator and passing a function. The generator example demonstrates stopping the coroutine after 1 second and resuming it after 5 seconds using AddTimer.

```python
#通过生成器执行协程
import client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateGame(clientApi.GetLevelId())

def callback():
    print "callback"

def coroutineTest():
    for i in xrange(1000):
        print i
        yield

generator = clientApi.StartCoroutine(coroutineTest, callback)
#执行1秒后停止协程
comp.AddTimer(1.0, clientApi.StopCoroutine, generator)
#执行5秒后传入StartCoroutine返回的生成器，则函数将从停止位置继续执行
comp.AddTimer(5.0, clientApi.StartCoroutine, generator, callback)

#----------------------------------------------------------------

#通过函数执行协程
import client.extraClientApi as clientApi
def callback():
    print "callback"

def coroutineTest():
    for i in xrange(1000):
        print i
        yield
#传入函数，函数将从头开始执行
clientApi.StartCoroutine(coroutineTest, callback)
```

--------------------------------

### setMoving - Client API Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%8E%A9%E5%AE%B6/%E8%A1%8C%E4%B8%BA.html

Client-side example for setting walking state. Only works for local player on mobile. Calls setMoving() on the player component.

```python
comp = clientApi.GetEngineCompFactory().CreatePlayer(entityId)
comp.setMoving()

```

--------------------------------

### GetFootPos Client Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E5%AE%9E%E4%BD%93/%E5%B1%9E%E6%80%A7.html

Client-side example to get the foot position of an entity. Returns a tuple of floats. Note: does not work while sleeping.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePos(entityId)
#获取位置：
entityFootPos = comp.GetFootPos()

```

--------------------------------

### GetFootPos Server Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E5%AE%9E%E4%BD%93/%E5%B1%9E%E6%80%A7.html

Server-side example to get the foot position of an entity. Returns a tuple of floats. Note: does not work while sleeping.

```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreatePos(entityId)
entityFootPos = comp.GetFootPos()

```

--------------------------------

### 脚本目录结构（JSON）

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcguide/20-%E7%8E%A9%E6%B3%95%E5%BC%80%E5%8F%91/13-%E6%A8%A1%E7%BB%84SDK%E7%BC%96%E7%A8%8B/2-Python%E8%84%9A%E6%9C%AC%E5%BC%80%E5%8F%91/0-%E8%84%9A%E6%9C%AC%E5%BC%80%E5%8F%91%E5%85%A5%E9%97%A8.html

展示tutorialScripts的目录结构，包括__init__.py、modMain.py、tutorialClientSystem.py和tutorialServerSystem.py等文件。

```json
| behavior_packs_xxx
	| entities
	| tutorialScripts
		| __init__.py
		| modMain.py
		| tutorialClientSystem.py
		| tutorialServerSystem.py
	| ...
	| manifest.json
```

--------------------------------

### ModelMoveTo example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E8%99%9A%E6%8B%9F%E4%B8%96%E7%95%8C/%E6%A8%A1%E5%9E%8B.html?catalog=1

Creates a virtual world component, creates a model object, sets its position, and moves it to a new position over 3 seconds with linear easing.

```python
import client.extraClientApi as clientApi
virtualWorldComp = clientApi.GetEngineCompFactory().CreateVirtualWorld(clientApi.GetLevelId())
objId = virtualWorldComp.ModelCreateObject("datiangou", "run")
virtualWorldComp.ModelSetPos(objId, (0.0, 0.0, 0.0))
virtualWorldComp.ModelMoveTo(objId, (0.0, 0.0, -10.0), 3.0, clientApi.GetMinecraftEnum().TimeEaseType.linear)
```

--------------------------------

### GetEntityLinksTag Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E5%AE%9E%E4%BD%93/%E5%B1%9E%E6%80%A7.html

Server-side example to get entities linked to the current entity, such as the rider of a horse. Returns a dict of linked entities.

```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreateEntityDefinitions(entityId)
result = comp.GetEntityLinksTag()

```

--------------------------------

### SetRaining Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E4%B8%96%E7%95%8C/%E5%A4%A9%E6%B0%94.html

Creates a weather component and sets rain with intensity 0.5 for 1000 frames. Requires the weather cycle to be enabled in game settings for the time parameter to take effect.

```python
import mod.server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreateWeather(levelId)
comp.SetRaining(0.5,1000)
```

--------------------------------

### GetItemEffectName - Client Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%89%A9%E5%93%81.html

Client-side example showing how to get the item's status description, such as '§7保护 0§r'. The example uses a banner item with auxValue 15 and userData {'Type': 1}.

```python
# 灾厄旗帜
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreateItem(levelId)
comp.GetItemEffectName("minecraft:banner", 15, {'Type': 1})

```

--------------------------------

### Server-side StartCoroutine example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E9%80%9A%E7%94%A8/%E5%B7%A5%E5%85%B7.html

Shows how to start a coroutine on the server using serverApi.StartCoroutine. Includes examples for both passing a generator and passing a function. The generator example demonstrates stopping the coroutine after 1 second and resuming it after 5 seconds using AddTimer.

```python
#通过生成器执行协程
import server.extraServerApi as serverApi
comp = serverApi.GetEngineCompFactory().CreateGame(serverApi.GetLevelId())

def callback():
    print "callback"

def coroutineTest():
    for i in xrange(1000):
        print i
        yield

generator = serverApi.StartCoroutine(coroutineTest, callback)
#执行1秒后停止协程
comp.AddTimer(1.0, serverApi.StopCoroutine, generator)
#5秒后传入StartCoroutine返回的生成器，则函数将从停止位置继续执行
comp.AddTimer(5.0, serverApi.StartCoroutine, generator, callback)

#----------------------------------------------------------------

#通过函数执行协程
import server.extraServerApi as serverApi
def callback():
    print "callback"

def coroutineTest():
    for i in xrange(1000):
        print i
        yield
#传入函数，函数将从头开始执行
serverApi.StartCoroutine(coroutineTest, callback)
```

--------------------------------

### GetItemHoverName example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/3-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/SDK%E6%8E%A5%E5%8F%A3%E5%B0%81%E8%A3%85SdkInterface.html?catalog=1

Example call to get the hover name for a banner item with aux value 15 and user data {'Type': 1}.

```python
self.GetItemHoverName("minecraft:banner", 15, {'Type': 1})
```

--------------------------------

### GetPickRange - Client Example

Source: https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI/%E6%8E%A5%E5%8F%A3/%E7%8E%A9%E5%AE%B6/%E8%A1%8C%E4%B8%BA.html?catalog=1

Client-side method to get the player's interaction distance. No parameters. Returns float. Example uses mod.client.extraClientApi.

```python
import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePlayer(playerId)
comp.GetPickRange()
```
Tokens:
Raw