其他API

杂项通用模块（MiscUtils）

客户端通用变量

变量名	类型	描述
MiscUtils.screenX	double	【只读】当前客户端屏幕左上角横坐标。
MiscUtils.screenY	double	【只读】当前客户端屏幕左上角纵坐标。
MiscUtils.screenWidth	int	【只读】当前客户端屏幕宽度（像素）。
MiscUtils.screenHeight	int	【只读】当前客户端屏幕高度（像素）。

通用函数

文本传输相关函数

注意：若使用了UTF8文本，请使用UTF8文本传输函数。

函数	返回值	描述
MiscUtils.Unicast(Player player, string message)	void	向指定玩家的客户端单播ASCII字符串。
MiscUtils.Broadcast(string message)	void	广播ASCII字符串到所有客户端。
MiscUtils.UnicastUTF8(Player player, string message)	void	向指定玩家的客户端单播UTF8字符串。
MiscUtils.BroadcastUTF8(string message)	void	广播UTF8字符串到所有客户端。

特殊效果相关函数

函数	返回值	描述
MiscUtils.RayDistance(double fromX, double fromY, double shootAngle, int maxDistance = 1000)	int	从一个点发射射线，返回碰到固体时射线经过的距离。maxDistance表示最远检测距离。
MiscUtils.RayReach(double fromX, double fromY, double toX, double toY)	bool	从一个点朝另外一个点发射射线，返回射线是否未与任何固体发生碰撞。
MiscUtils.CreateExplosion(int xi, int yi, double power, bool hurtNpc, bool hurtPlayer, bool killTiles = true, bool killWalls = false, bool makeSound = true, int tileLimit = -1)	void	在指定格子位置发生一个爆炸。power表示爆炸攻击力。hurtNpc表示是否对NPC有效。hurtPlayer表示是否对玩家有效。killTiles表示是否破坏前景。killWalls表示是否破坏背景墙。makeSound表示是否发出爆炸音效。tileLimit为正数时表示爆炸作用的最小方块硬度，为负数表示作用全部方块。

世界数据相关函数

函数	返回值	描述
MiscUtils.SetDayTime(int dayTime)	void	设置当日时间。一天的时间为0-86400，对应早上6:00到次日早上6:00。
MiscUtils.SetDayTimeFormat(int hours, int minutes, int seconds)	void	设置当日时间。hours表示小时数，minutes表示分钟数，seconds表示秒数。
MiscUtils.GetDayTime()	int	获取当日时间。
MiscUtils.GetDayTimeFormat()	int, int, int	获取当日时间，依次返回小时数、分钟数、秒数。
MiscUtils.SetDaySpeed(double daySpeed)	void	设置时间流逝速度比率。
MiscUtils.GetDaySpeed()	double	获取时间流逝速度比率。
MiscUtils.SetWeatherTime(int weatherTime)	void	设置天气事件进行时间。总时间为216000。
MiscUtils.GetWeatherTime()	int	获取天气事件进行时间。

服务端相关函数

函数	返回值	描述
MiscUtils.SaveAll()	void	立即保存全部数据。若服务端当前正在执行保存任务，则结束任务后立即执行当前请求。
MiscUtils.SetAutoSaveEnabled(bool enabled)	void	决定是否开启自动保存模式。enabled为true时开启自动保存，为false时关闭自动保存。
MiscUtils.GetAutoSaveEnabled()	bool	返回是否开启了自动保存模式。
MiscUtils.GetPortNumber()	int	返回服务器的端口号。如果是客户端调用，总是返回0。
MiscUtils.SetPVP(bool enabled)	void	决定是否开启玩家对战模式。enabled为true时开启玩家对战，为false时关闭玩家对战。
MiscUtils.GetPVP()	bool	返回是否开启了玩家对战模式。
MiscUtils.SetSafeBlow(bool enabled)	void	决定是否开启爆炸保护模式。enabled为true时开启爆炸保护模式，为false时关闭爆炸保护模式。爆炸保护在开启状态下所有爆炸均不会破坏方块。
MiscUtils.GetSafeBlow()	bool	返回是否开启了爆炸保护模式。
MiscUtils.SetGameMode(GameMode gameMode)	void	设置世界游戏模式。
MiscUtils.GetGameMode()	GameMode	获取世界游戏模式。
MiscUtils.GetOnlinePlayerList()	ArrayList<Player>	获取所有在线玩家。
MiscUtils.KickPlayer(string playerName)	bool	将指定名称的玩家踢出服务器，返回是否踢出成功。
MiscUtils.KickAllPlayers()	int	将所有玩家踢出服务器，返回踢出玩家的个数。
MiscUtils.Ban(string ip)	void	封禁指定IP，并将该IP加入服务器黑名单。
MiscUtils.RemoveBan(string ip)	bool	从服务器黑名单中移除指定IP。
MiscUtils.GetBlackList()	ArrayList<string>	获取服务器IP黑名单，返回封禁的IP列表。