道具百科
触发器百科
脚本API百科
创作手册
创作功能
其他
Studio百科
玩家接口:Player
彼得兔 更新时间: 2024-04-11 15:48:00

继承自 Actor

具体函数名及描述如下:

序号 函数名 函数描述
1 getAttr(...) 玩家属性获取
2 setAttr(...) 玩家属性设置
3 getHostUin(...) 获取房主uin
4 isMainPlayer(...) 是否是本地玩家
5 getMainPlayerUin(...) 获取本地玩家的uin
6 getGameResults(...) 获取玩家比赛结果
7 setGameResults(...) 设置玩家比赛结果
8 getGameScore(...) 获取玩家游戏分数
9 setGameScore(...) 设置玩家游戏分数
10 getGameRanking(...) 获取玩家的排行
11 setGameRanking(...) 给玩家设置排行
12 gainItems(...) 给玩家增加道具
13 teleportHome(...) 传送到出生点
14 getCurToolID(...) 获取玩家当前手持的物品id
15 getNickname(...) 获取玩家昵称
16 removeBackpackItem(...) 移走背包里的物品
17 getDieTimes(...) 获取玩家死亡次数
18 getLeftLifeNum(...) 获取玩家剩下的生命次数
19 setTeam(...) 设置玩家队伍
20 getTeam(...) 获取玩家队伍
21 getFoodLevel(...) 获取当前饱食度
22 setFoodLevel(...) 设置玩家饱食度
23 getCurShotcut(...) 获取当前所用快捷栏键
24 onCurToolUsed(...) 设置当前玩家手持的道具消耗
25 setSkillCD(...) 设置CD
26 reviveToPos(...) 复活玩家到指定点
27 setRevivePoint(...) 改变玩家复活点位置
28 mountActor(...) 玩家乘上坐骑
29 playAct(...) 玩家播放动画
30 notifyGameInfo2Self(...) 对玩家显示飘窗文字
31 useItem(...) 使玩家使用当前道具
32 rotateCamera(...) 旋转玩家镜头
33 changeViewMode(...) 改变玩家视角模式
34 setActionAttrState(...) 设置玩家行为属性状态
35 checkActionAttrState(...) 获取玩家特殊属性的状态
36 isEquipByResID(...) 设置玩家是否装备了某件装备
37 setPosition(...) 设置player位置
38 getAimPos(...) 获取player准星位置
39 setItemAttAction(...) 设置玩家道具设置属性:丢弃、掉落
40 playMusic(...) 对玩家播放背景音乐
41 stopMusic(...) 停止播放玩家背景音乐
42 setGameWin(...) 使玩家获得游戏胜利
43 openDevStore(...) 打开开发者商店
44 getPropsType(...) 玩家手持道具的类型
45 —— ——
46 setCheckBoxScale(...) 设置检测掉落物半径
47 openBoxByPos(...) 打开可以操作的箱子
48 forceOpenBoxUI(...) 强制打开可以操作的方块 如工具箱
49 openDevGoodsBuyDialog(...) customDesc : 自定义商品描述
50 —— ——
51 changPlayerMoveType(...) 改变玩家移动方式
52 setImmuneType(...) 设置玩家免疫伤害类型开关
53 shakeCamera(...) 抖动玩家摄像机
54 stopShakeCamera(...) 停止抖动玩家摄像机
55  playQQMusic(...)
玩家播放qq音乐
56 operateQQMusic(...)
暂停/恢复/停止玩家的QQ音乐
57 OpenAppraiseView(...)
打开评价界面
58 OpenCollectionView(...)
打开收藏界面
59 IsMiniVip(...)
是否为迷你会员
60 SendFriendApply(...)
发送好友请求
61 HasFriend(...)
是否是好友判断
62 PlayActInHand(...)
手持道具播放动画
63 openDevStoreNew(...)
玩家打开开发者商店(仅开发者可用)
64 OpenBuiltinRank(...)
打开内置排行榜
65 HideBuiltinRank(...)
隐藏内置排行榜
66 —— ——
67 openDevGoodsBuyDetailedDialog(...)
打开开发者商店商品详情页
68 setMobileVibrate(...)
玩家手机震动
69 SetCameraPosTransformBy(...)
玩家摄像机变换相对位置
70 SetCameraPosTransformTo(...)
玩家摄像机变换到位置
71 SetCameraRotTransformBy(...)
玩家摄像机旋转相对角度
72 SetCameraRotTransformTo(...)
玩家摄像机旋转到角度
73 SetCameraFovTransformBy(...)
玩家摄像机Fov变换相对值
74 SetCameraFovTransformTo(...)
玩家摄像机Fov变换到值
75 SetCameraAttrState(...)
设置玩家的摄像机设置开关
76 SetCameraRotMode(...)
设置玩家的摄像机旋转模式
77 SetCameraMountObj(...)
设置玩家的摄像机挂载到对象
78 SetCameraMountPos(...)
设置玩家的摄像机挂载到位置
79 ResetCameraAttr(...)
重置玩家摄像机
80 openDevGoodsSkinBuyDialog(...)
打开皮肤商品购买弹框
81 openDevGoodsSkinDetail(...)

打开皮肤商品详情页

(仅限自定义UI按钮响应事件)

82 openDevGoodsSkin(...)
打开皮肤商店(仅限自定义UI按钮响应事件)
83 OpenInviteBulletBox(...)
打开好友邀请界面
84 GetFirstInviter(...)
获取玩家首次邀请人(阻塞接口,请求间隔10s)
85 GetInviteGroupS(...)
获取玩家新邀请的玩家(阻塞接口)
86 OpenDevGoodsPage(...)
打开开发者商店页面
87 GetPlayerCostStatic(...)
获取玩家的消费统计

 

getAttr

--获取房主的生命值
--第一个参数0为游戏玩家id或玩家迷你号,0是房主
--第二个参数2是属性:当前生命值,具体可以在“游戏数据类型”的“玩家属性枚举”中查看
local result,value=Player:getAttr(0,2)
--在聊天框显示
Chat:sendSystemMsg("房主当前生命值为:"..value)

setAttr

--设置房主的生命上限
--第一个参数0为游戏玩家id或玩家迷你号,0是房主
--第二个参数1是属性:生命上限,具体可以在“游戏数据类型”的“玩家属性枚举”中查看
--第三个参数500是需要设置属性的值
Player:setAttr(0,1,500)
--在聊天框显示
Chat:sendSystemMsg("房主生命上限被设置为500")

getHostUin

  • 参数及类型:nil

  • 返回值及类型:

  • 该方法的主要作用:获取房主uin

  • 具体使用案例如下:

--获取房主迷你号
local result,uin=Player:getHostUin()
--在聊天框显示
Chat:sendSystemMsg("房主迷你号为:"..uin)

isMainPlayer

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:是否是本地玩家

  • 具体使用案例如下:

--判断某迷你号是不是本地玩家(房主)
--参数1000是需要判断的迷你号
local result=Player:isMainPlayer(1000)
if result==0 then--如果是
	--在聊天框显示
	Chat:sendSystemMsg("1000是本地玩家(房主)")
else--如果不是
	--在聊天框显示
	Chat:sendSystemMsg("1000不是本地玩家(房主)")
end

getMainPlayerUin

  • 参数及类型:nil

  • 返回值及类型:

  • 该方法的主要作用:获取本地玩家的uin

  • 具体使用案例如下:

--获取本地玩家(房主)迷你号
local result,uin=Player:getMainPlayerUin()
--在聊天框显示
Chat:sendSystemMsg("本地玩家(房主)迷你号为:"..uin)

getGameResults

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家比赛结果

  • 具体使用案例如下:

--获取玩家的游戏状态或比赛结果
--参数0是玩家id或玩家迷你号,0是房主
--返回值可能是:0游戏中 1游戏胜利 2游戏结束
local result,value=Player:getGameResults(0)
Chat:sendSystemMsg("当前房主的游戏状态是(0游戏中 1游戏胜利 2游戏结束):"..value)

setGameResults

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置玩家比赛结果

  • 具体使用案例如下:

--设置玩家的游戏状态或比赛结果
--第一个参数是玩家id或玩家迷你号,0是房主
--第二个参数为游戏状态或比赛结果:0游戏中 1游戏胜利 2游戏结束
Player:setGameResults(0,1)
--在聊天框显示
Chat:sendSystemMsg("设置房主游戏胜利")

getGameScore

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家游戏分数

  • 具体使用案例如下:

--当玩家做动画表情时在聊天框显示房主游戏分数
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--获取房主的游戏分数
	--参数0为玩家id或玩家迷你号,0是房主
	local result,value=Player:getGameScore(0)
	--在聊天框显示
	Chat:sendSystemMsg("房主当前的游戏分数为"..value)
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

setGameScore

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置玩家游戏分数

  • 具体使用案例如下:

--把房主的分数设为100(玩家分数不是玩家所在队伍的分数,要注意区别。队伍分数可查阅Team)
--第一个参数是玩家id或玩家迷你号,0是房主
--第二个参数为要设置的游戏分数
Player:setGameScore(0,100)
--在聊天框显示
Chat:sendSystemMsg("房主的游戏分数被设置为了100(玩家分数不是玩家所在队伍的分数)")

getGameRanking

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家的排行

  • 具体使用案例如下:

--获取玩家的游戏排行
--参数0为玩家id或玩家迷你号,0是房主
local result,rank=Player:getGameRanking(0)
--在聊天框显示
Chat:sendSystemMsg("房主的游戏排行为"..rank)

setGameRanking

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:给玩家设置排行

  • 具体使用案例如下:

--设置房主的排行为第一名
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为玩家排行
Player:setGameRanking(0,1)
--在聊天框显示
Chat:sendSystemMsg("房主排行被设置为了第一名")

gainItems

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:给玩家增加道具

  • 具体使用案例如下:

--给玩家背包增加某道具或物品
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数是添加物品的id,1是基岩
--第三个参数是添加的物品数量
--最后一个参数是优先快捷栏还是背包栏:1优先快捷栏 2优先背包栏
Player:gainItems(0,1,10,1)
--在聊天框显示
Chat:sendSystemMsg("给房主快捷栏或背包增加了10个基岩")

teleportHome

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:传送到出生点

  • 具体使用案例如下:

--每当玩家做动画表情房主都会被传送回出生点
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--把玩家传送至出生点,参数为玩家id或玩家迷你号,0是房主
	Player:teleportHome(0)
	--在聊天框显示
	Chat:sendSystemMsg("房主被传送到了出生点")
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

getCurToolID

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家当前手持的物品id

  • 具体使用案例如下:

--获取玩家手持物品的id,参数为玩家id或玩家迷你号,0是房主
local result,id=Player:getCurToolID(0)
--在聊天框显示
Chat:sendSystemMsg("房主当前拿着的物品的id为"..id)

getNickname

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家昵称

  • 具体使用案例如下:

--获取玩家昵称,参数为玩家id或玩家迷你号,0是房主
local result,name=Player:getNickname(0)
--在聊天框显示
Chat:sendSystemMsg("房主的昵称为:"..name)

removeBackpackItem

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:移走背包里的物品

  • 具体使用案例如下:

--移除玩家背包里的物品
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为要移除的物品id,101是土块
--第三个参数为要移除的物品数量
Player:removeBackpackItem(0,101,10)
--在聊天框显示
Chat:sendSystemMsg("移除了房主背包里的10个土块")

getDieTimes

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家死亡次数

  • 具体使用案例如下:

--每当玩家做动画表情,聊天框显示房主死亡次数
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--获取玩家死亡次数,参数为玩家id或玩家迷你号,0是房主
	local result,value=Player:getDieTimes(0)
	--在聊天框显示
	Chat:sendSystemMsg("房主的死亡次数为"..value)
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

getLeftLifeNum

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家剩下的生命次数

  • 具体使用案例如下:

--每当玩家做动画表情,聊天框显示房主剩余生命数
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--获取玩家剩余生命数,参数为玩家id或玩家迷你号,0是房主
	local result,value=Player:getLeftLifeNum(0)
	--在聊天框显示
	Chat:sendSystemMsg("房主剩余生命数为"..value)
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

setTeam

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置玩家队伍

  • 具体使用案例如下:

--设置玩家队伍
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为要设置为的队伍
Player:setTeam(0,2)
--在聊天框显示
Chat:sendSystemMsg("房主被设置为第二队")

getTeam

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家队伍

  • 具体使用案例如下:

--获取玩家所在队伍,参数为玩家id或玩家迷你号,0是房主
local result,value=Player:getTeam(0)
--在聊天框显示
Chat:sendSystemMsg("房主所在队伍为:"..value)

getFoodLevel

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取当前饱食度

  • 具体使用案例如下:

--获取玩家饱食度,参数为玩家id或玩家迷你号,0是房主
local result,value=Player:getFoodLevel(0)
--在聊天框显示
Chat:sendSystemMsg("房主当前饱食度为"..value)

setFoodLevel

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置玩家饱食度

  • 具体使用案例如下:

--设置玩家饱食度
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为要设置的饱食度
Player:setFoodLevel(0,100)
--在聊天框显示
Chat:sendSystemMsg("设置房主的饱食度为100")

getCurShotcut

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取当前所用快捷栏键

  • 具体使用案例如下:

--获取玩家当前选中的快捷栏位置,参数为玩家id或玩家迷你号,0是房主
local result,scutIdx=Player:getCurShotcut(0)
--在聊天框显示
Chat:sendSystemMsg("房主当前选中的快捷栏为:"..scutIdx)

onCurToolUsed

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置当前玩家手持的道具消耗

  • 具体使用案例如下:

--设置玩家手持物品的消耗
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为消耗的道具数量(貌似没效果)
Player:onCurToolUsed(0,1)
--在聊天框显示
Chat:sendSystemMsg("房主当前选中的物品被移除了1个")

setSkillCD

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置CD

  • 具体使用案例如下:

--每当玩家做动画表情,房主的钻石剑CD都会变为100秒
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--设置玩家的道具CD
	--第一个参数为玩家id或玩家迷你号,0是房主
	--第二个参数为道具id,12005是能量剑(钻石剑)
	--第三个参数为设置的技能冷却时长
	Player:setSkillCD(0,12005,100)
	--在聊天框显示
	Chat:sendSystemMsg("房主的钻石剑技能冷却时间被设置为了100秒")
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

reviveToPos

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:复活玩家到指定点

  • 具体使用案例如下:

--复活玩家到指定位置(貌似没效果,也许只对死亡玩家有效)
--第一个参数为玩家id或玩家迷你号,0是房主
--后三个参数为复活到坐标
Player:reviveToPos(0,50,7,50)
--在聊天框显示
Chat:sendSystemMsg("把房主复活到(50,50)高度7的位置")

setRevivePoint

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:改变玩家复活点位置

  • 具体使用案例如下:

--设置玩家的复活点坐标
--第一个参数为玩家id或玩家迷你号,0是房主
--后三个参数为设置的复活点坐标
Player:setRevivePoint(0,50,7,50)
--在聊天框显示
Chat:sendSystemMsg("房主复活点被设置在了(50,50)高度7的位置")

mountActor

  • 参数及类型:

    • objid:number玩家Uin
    • objid:number坐骑ID(传入0,登下坐骑)
    • bctrl:boolean是否可以控制(默认不可控制)
  • 返回值及类型:

  • 该方法的主要作用:玩家乘上坐骑

  • 具体使用案例如下:

local function ClickActor(event)
	local playerid=event.eventobjid--玩家
	local objid=event.toobjid--要骑乘的实体id
	local posindex=1--骑乘位
	--让玩家骑乘生物
	Player:mountActor(playerid, objid, posindex)
end
ScriptSupportEvent:registerEvent([=[Player.ClickActor]=], ClickActor)--点击生物
local function ClickBlock(event)
	local playerid=event.eventobjid--玩家
	--让玩家取消骑乘
	Player:mountActor(playerid)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

playAct

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:玩家播放动画

  • 具体使用案例如下:

--让玩家播放动画表情
--第一个参数为玩家迷你号
--第二个参数为动作表情id,具体可以在“迷你世界ID查询”的“动作表数据”查询
Player:playAct(1000,1)
--在聊天框显示
Chat:sendSystemMsg("让迷你号为1000的玩家播放打招呼动作")

notifyGameInfo2Self

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:对玩家显示飘窗文字

  • 具体使用案例如下:

--对玩家显示飘窗提示框
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数是显示的文本内容
Player:notifyGameInfo2Self(0,"这里是飘窗文字内容")

useItem

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:使玩家使用当前道具

  • 具体使用案例如下:

local function ClickBlock(event)
	local objid=event.eventobjid--使用道具的玩家
	local itemid=12005--使用的道具id
	local status=1--使用状态(意义不明)
	local onshift=false--是否按下shift:否
	--使玩家使用道具(貌似无效)
	Player:useItem(objid, itemid, status, onshift)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

rotateCamera

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:旋转玩家镜头

  • 具体使用案例如下:

--设置玩家视角方向
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为水平方向旋转角度,正北为0,由北向东为正方向
--第三个参数为俯仰角,90为俯视,-90为仰视,之间的角度可任意设置
Player:rotateCamera(0,90,90)
--在聊天框显示
Chat:sendSystemMsg("房主视角被设置为面向正东、俯视")

changeViewMode

--设置玩家视角模式
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为视角模式:0主视角 1背视角 2正视角 3俯视角 4俯视角 5自定义视角
--第三个参数为是否锁定视角:true锁定 false不锁定
Player:changeViewMode(0,0,true)
--在聊天框显示
Chat:sendSystemMsg("锁定房主视角为第一人称主视角")

setActionAttrState

--设置玩家行为属性状态
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数是行为属性值,1是“移动”,具体可以在“游戏数据类型”的“玩家属性设置”里查看
--第三个参数为“是否可以”,true可以 false不可以
Player:setActionAttrState(0,1,false)
--在聊天框显示
Chat:sendSystemMsg("设置房主不可移动")

checkActionAttrState

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取玩家特殊属性的状态

  • 具体使用案例如下:

--获取玩家的行为属性状态
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数是行为属性值,1是“移动”,具体可以在“游戏数据类型”的“玩家属性设置”里查看
local result=Player:checkActionAttrState(0,1)
if result==0 then--如果可以
	--在聊天框显示
	Chat:sendSystemMsg("房主可以移动")
else--如果不可以
	--在聊天框显示
	Chat:sendSystemMsg("房主不可移动")
end

isEquipByResID

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置玩家是否装备了某件装备

  • 具体使用案例如下:

local function ClickBlock(event)
	local objid=event.eventobjid--检测的玩家
	local itemid=12241--要检测的装备,这里是蓝钻头盔
	--获取玩家是否穿戴itemid装备
	local result=Player:isEquipByResID(objid, itemid)
	if result==0 then
		Chat:sendSystemMsg("玩家穿着蓝钻头盔")
	else
		Chat:sendSystemMsg("玩家没有穿戴蓝钻头盔")
	end
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

setPosition

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置player位置

  • 具体使用案例如下:

--设置玩家到某坐标
--第一个参数为玩家id或玩家迷你号,0是房主
--后三个参数为设置到的坐标
Player:setPosition(0,100,7,100)
--在聊天框显示
Chat:sendSystemMsg("房主被设置到了(100,100)高度7的位置")

getAimPos

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:获取player准星位置

  • 具体使用案例如下:

--获取玩家准心坐标,参数为玩家id或玩家迷你号,0是房主
local result,x,y,z=Player:getAimPos(0)
--在聊天框显示
Chat:sendSystemMsg("房主当前准心坐标为("..x..","..y..","..z..")")
--输出到控制台
print("房主当前准心坐标为("..x..","..y..","..z..")")

setItemAttAction

--设置玩家的道具的操作属性
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为要设置的道具的id,101是土块
--第三个参数为属性值:1不可丢弃 2不可掉落
--最后一个参数为是否开启属性:true开启 false关闭
Player:setItemAttAction(0,101,1,true)
--在聊天框显示
Chat:sendSystemMsg("房主被设置为不可丢弃土块")

playMusic

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:对玩家播放背景音乐

  • 具体使用案例如下:

--对玩家播放音乐
--第一个参数为玩家id或玩家迷你号,0是房主
--第二个参数为音乐id,具体可以在“迷你世界ID表查询”的“音效表数据”里查看
--第三个参数为播放音量
--第四个参数为播放音高
--最后一个参数为是否循环播放
Player:playMusic(0,10713,100,1,false)
--在聊天框显示
Chat:sendSystemMsg("开始对房主播放音乐10713")

stopMusic

  • 参数及类型:

    • objid:number玩家Uin
    • musicId:string声音ID
  • 返回值及类型:

    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用:停止播放玩家背景音乐

  • 具体使用案例如下:

--对房主播放音乐10713
Player:playMusic(0,10713,100,1,false)
--在聊天框显示
Chat:sendSystemMsg("开始对房主播放音乐10713,做动画表情即可停止播放")
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--停止对玩家播放音乐,参数为玩家id或玩家迷你号,0是房主
	Player:stopMusic(0)
	--在聊天框显示
	Chat:sendSystemMsg("停止对房主播放音乐")
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

setGameWin

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:使玩家获得游戏胜利

  • 具体使用案例如下:

--每当玩家做动画表情,让指定迷你号的玩家获胜
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--指定迷你号玩家获胜,参数为玩家迷你号
	local result=Player:setGameWin(1000)
	if result==0 then--如果房间里存在迷你号为1000的玩家
		--在聊天框显示
		Chat:sendSystemMsg("设置玩家1000获胜")
	else--如果房间里没有迷你号为1000的玩家
		--在聊天框显示
		Chat:sendSystemMsg("房间里没有玩家迷你号为1000")
	end
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

openDevStore

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:打开开发者商店

  • 具体使用案例如下:

--每当玩家做动画表情,为指定玩家打开开发者商店
--当玩家做动画表情时执行此函数
local function Player_PlayAction(event)
	--为指定玩家打开开发者商店,参数为玩家id或玩家迷你号,0是房主
	Player:openDevStore(0)
	--在聊天框显示
	Chat:sendSystemMsg("为房主打开了开发者商店")
end
--注册一个动画表情监听器,事件发生时执行上面的函数
ScriptSupportEvent:registerEvent([=[Player.PlayAction]=],Player_PlayAction)

getPropsType

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:玩家手持道具的类型

  • 具体使用案例如下:

local function ClickBlock(event)
	local playerid=event.eventobjid--玩家
	--获取玩家手持道具id
	local result,id=Player:getPropsType(playerid)
	if result==0 then
		Chat:sendSystemMsg("玩家手持道具id为".. id)
	else
		Chat:sendSystemMsg("玩家当前没有手持道具")
	end
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

 

setCheckBoxScale

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置检测掉落物半径

  • 具体使用案例如下:

local function ClickBlock(event)
	local objid=event.eventobjid--玩家
	local range=10--缩放倍数
	--设置玩家检测掉落物半径放大10倍
	Player:setCheckBoxScale(objid, range)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

openBoxByPos

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用:打开可以操作的箱子
  • 具体使用案例如下:
local function ClickBlock(event)
	local objid=event.eventobjid--玩家
	local x,y,z=0,7,0--箱子坐标
	--为玩家打开位于(0,0)高度7处的箱子(前提是这个位置有箱子且可以打开)
	Player:openBoxByPos(objid, x, y, z)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

forceOpenBoxUI

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用:强制打开可以操作的方块 如工具箱
  • 具体使用案例如下:
local function ClickBlock(event)
	local objid=event.eventobjid--玩家
	local itemid=824--可以操作的方块id,这里是黄铜工匠台
	--为玩家打开操作界面(不需要实际放置)
	Player:forceOpenBoxUI(objid, itemid)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

openDevGoodsBuyDialog

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:打开开发者商店商品弹窗

  • 具体使用案例如下:

local function ClickBlock(event)
	local objid=event.eventobjid--玩家
	local devGoodsId=1--商品id,具体可在脚本编辑界面ID库查询
	local customDesc="商品描述"--商品描述
	--为玩家打开开发者商品购买弹窗
	Player:openDevGoodsBuyDialog(objid, devGoodsId, customDesc)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

 

changPlayerMoveType

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:改变玩家移动方式

  • 具体使用案例如下:

local function ClickBlock(event)
    local objid=event.eventobjid--点击方块的玩家
    local moveType=1--移动方式:1飞行 2默认
    --设置玩家的移动方式为飞行
	Player:changPlayerMoveType(objid, moveType)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块,执行函数ClickBlock

setImmuneType

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:设置玩家免疫伤害类型

  • 具体使用案例如下:

local function ClickBlock(event)
	local objid=event.eventobjid--点击方块的玩家
	local immunetype=0--近战伤害(伤害类型可在常量列表查询)
	local isadd=true--开启
	--给玩家开启免疫近战伤害
	Player:setImmuneType(objid, immunetype, isadd)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

shakeCamera

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:抖动玩家镜头

  • 具体使用案例如下:

local function ClickBlock(event)
	local objid=event.eventobjid--要抖动镜头的玩家,这里是点击方块的玩家
	local duration=10--抖动持续秒数
	local power=100--抖动力度
	--抖动玩家的镜头持续duration秒,力度为power
	Player:shakeCamera(objid, duration, power)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块

stopShakeCamera

  • 参数及类型:

  • 返回值及类型:

  • 该方法的主要作用:停止抖动玩家镜头

  • 具体使用案例如下:

--玩家点击方块,开始抖动镜头持续1000秒
local function ClickBlock(event)
	local objid=event.eventobjid--要抖动镜头的玩家,这里是点击方块的玩家
	local duration=1000--抖动持续秒数
	local power=100--抖动力度
	--抖动玩家的镜头持续duration秒,力度为power
	Player:shakeCamera(objid, duration, power)
end
ScriptSupportEvent:registerEvent([=[Player.ClickBlock]=], ClickBlock)--点击方块
--玩家点击生物,停止镜头抖动
local function ClickActor(event)
	local objid=event.eventobjid--要停止抖动镜头的玩家,这里是点击生物的玩家
	--停止抖动玩家的镜头
	Player:stopShakeCamera(objid)
end
ScriptSupportEvent:registerEvent([=[Player.ClickActor]=], ClickActor)--点击生物

 

playQQMusic

  • 参数及类型:
    • objid:number玩家ID
    • musicId:number音乐ID
    • volume:number音量
    • isLoop:boolean是否循环
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:玩家播放qq音乐
  • 具体使用案例如下:
local result = Player:playQQMusic(objid,musicId,valume,idLoop)

 

operateQQMusic 

  • 参数及类型:
    • operate:numberQQMUSICOP
    • objid:number玩家ID
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:暂停/恢复/停止玩家的QQ音乐
  • 具体使用案例如下:
local result = Player:playQQMusic(objid,musicId,valume,idLoop)

 

OpenAppraiseView(...)

  • 参数及类型:
    • objid:number玩家ID
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:打开评价界面(用户游玩游戏超过3分钟后才能触发。触发后有十分钟的CD)
  • 具体使用案例如下:
local function callback(event)
  local ret = Player:OpenAppraiseView(event.eventobjid)
  if ret == ErrorCode.OK then
      print('打开成功')
  end
end
ScriptSupportEvent:registerEvent([[Player.ClickBlock]],callback) --点击方块事件

 

OpenCollectionView(...)

  • 参数及类型:
    • objid:number玩家ID
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:打开收藏界面(用户游玩游戏超过3分钟后才能触发。触发后有十分钟的CD)
  • 具体使用案例如下:
local function callback(event)
  local ret = Player:OpenCollectionView(event.eventobjid)
  if ret == ErrorCode.OK then
      print('打开成功')
  end
end
ScriptSupportEvent:registerEvent([[Player.ClickBlock]],callback) --点击方块事件

 

IsMiniVip(...)

  • 参数及类型:
    • objid:number玩家ID
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:判断是否是迷你会员
  • 具体使用案例如下:
local function callback(event)
  local ret = Player:IsMiniVip(event.eventobjid)
  if ret == ErrorCode.OK then
      print('玩家是会员')
  else
      print('玩家不是会员')
  end
end
ScriptSupportEvent:registerEvent([[Player.ClickBlock]],callback) --点击方块事件

 

SendFriendApply

  • 参数及类型:
    • playerid:number发送请求的玩家ID
    • playerid2:number被添加的好友ID
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:发送好友请求
  • 具体使用案例如下:
local result = Player:SendFriendApply(playerid,playerid2)

 

HasFriend

  • 参数及类型:
    • playerid:number发送请求的玩家ID
    • playerid2:number判断是否是好友的ID
  • 返回值及类型:
    • ErrorCode.OK
  • 该方法的主要作用:判断playerid是否有好友playerid2
  • 具体使用案例如下:
local result = Player:HasFriend(playerid,playerid2)

 

PlayActInHand

  • 参数及类型:
    • playerid:number玩家ID
    • animid:number动作ID
    • playmode:number播放模式(ANIMMODE)
  • 返回值及类型:
    • ErrorCode.OK
    • value:number 属性值
  • 该方法的主要作用:玩家手持微缩道具播放动画
  • 具体使用案例如下:
local result = Player:PlayActInHand(objid,12,ITEMATTR.ATTACK) --指定玩家当前选择的微缩道具循环播放跑动画

 

openDevStoreNew

  • 参数及类型:
    • objid:number玩家Uin
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家打开开发者商店(仅开发者可用)
  • 具体使用案例如下:
local code  = Player:openDevStoreNew(objid)
if code == ErrorCode.OK then
	print('执行成功'  )
else
	print('执行失败')
end

 

OpenBuiltinRank

  • 参数及类型:
    • objid:number对象ID
    • id:number排行榜ID(也可填索引)
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开内置排行榜
  • 具体使用案例如下:
local code  = Player:OpenBuiltinRank(playerid, id)
if code == ErrorCode.OK then
	print('执行成功'  )
else
	print('执行失败')
end

 

HideBuiltinRank

  • 参数及类型:
    • objid:number对象ID
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 隐藏内置排行榜
  • 具体使用案例如下:
local code  = Player:HideBuiltinRank(playerid)
if code == ErrorCode.OK then
	print('执行成功'  )
else
	print('执行失败')
end

 

openDevGoodsBuyDetailedDialog

  • 参数及类型:
    • objid:number玩家Uin
    • devGoodsId:number商品ID
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开开发者商店商品详情页
  • 具体使用案例如下:
local code  = Player:openDevGoodsBuyDetailedDialog(objid, devGoodsId)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

setMobileVibrate

  • 参数及类型:
    • playerid:number玩家Uin
    • time:number震动时长(单位:ms)
    • amplitude:number震动强度(范围:1~255)
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家手机震动
  • 具体使用案例如下:
local code  = Player:setMobileVibrate(playerid, time, amplitude)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraPosTransformBy

  • 参数及类型:
    • playerid:number玩家Uin
    • vec:table变换轴向,不变换的轴向可不填({x=100 y=100}摄像机xy轴分别增加100)
    • animid:number动画枚举(LinearTransformation)LinearTransformation
    • time:number动画时长
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家摄像机变换相对位置
  • 具体使用案例如下:
local code  = Player:SetCameraPosTransformBy(playerid, vec, animid, time)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraPosTransformTo

  • 参数及类型:
    • playerid:number玩家Uin
    • vec:table变换轴向,不变换的轴向可不填({x=100 y=100}摄像机xy轴分别变换到100的位置)
    • animid:number动画枚举(LinearTransformation)LinearTransformation
    • time:number动画时长
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家摄像机变换到位置
  • 具体使用案例如下:
local code  = Player:SetCameraPosTransformTo(playerid, vec, animid, time)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraRotTransformBy

  • 参数及类型:
    • playerid:number玩家Uin
    • vec:table变换轴向,不变换的轴向可不填({x=90 y=90}摄像机xy轴分别旋转90度)
    • animid:number动画枚举(LinearTransformation)LinearTransformation
    • time:number动画时长
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家摄像机旋转相对角度
  • 具体使用案例如下:
local code  = Player:SetCameraRotTransformBy(playerid, vec, animid, time)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraRotTransformTo

  • 参数及类型:
    • playerid:number玩家Uin
    • vec:table变换轴向,不变换的轴向可不填({x=90 y=90}摄像机xy轴分别旋转到90度)
    • animid:number动画枚举(LinearTransformation)LinearTransformation
    • time:number动画时长
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家摄像机旋转到角度
  • 具体使用案例如下:
local code  = Player:SetCameraRotTransformTo(playerid, vec, animid, time)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraFovTransformBy

  • 参数及类型:
    • playerid:number玩家Uin
    • value:number视场角
    • animid:number动画枚举(LinearTransformation)LinearTransformation
    • time:number动画时长
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家摄像机Fov变换相对值
  • 具体使用案例如下:
local code  = Player:SetCameraFovTransformBy(playerid, value, animid, time)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraFovTransformTo

  • 参数及类型:
    • playerid:number玩家Uin
    • value:number视场角
    • animid:number动画枚举(LinearTransformation)LinearTransformation
    • time:number动画时长
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 玩家摄像机Fov变换到值
  • 具体使用案例如下:
local code  = Player:SetCameraFovTransformTo(playerid, value, animid, time)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraAttrState

  • 参数及类型:
    • playerid:number玩家Uin
    • attr:number摄像机属性(CameraModel)CameraModel
    • enable:boolean是否
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 设置玩家的摄像机设置开关
  • 具体使用案例如下:
local code  = Player:SetCameraAttrState(playerid, attr, enable)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraRotMode

  • 参数及类型:
    • playerid:number玩家Uin
    • attr:number摄像机旋转模式(CameraRotate)CameraRotate
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 设置玩家的摄像机旋转模式
  • 具体使用案例如下:
local code  = Player:SetCameraRotMode(playerid, attr)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraMountObj

  • 参数及类型:
    • playerid:number玩家Uin
    • objid:number对象objid
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 设置玩家的摄像机挂载到对象
  • 具体使用案例如下:
local code  = Player:SetCameraMountObj(playerid, objid)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

SetCameraMountPos

  • 参数及类型:
    • playerid:number玩家Uin
    • pos:table位置坐标
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 设置玩家的摄像机挂载到位置
  • 具体使用案例如下:
local code  = Player:SetCameraMountPos(playerid, pos)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

ResetCameraAttr

  • 参数及类型:
    • playerid:number玩家Uin
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 重置玩家摄像机
  • 具体使用案例如下:
local code  = Player:ResetCameraAttr(playerid)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

openDevGoodsSkinBuyDialog

  • 参数及类型:
    • playerid:number玩家Uin
    • skin:string模型ID
    • desc:string描述语
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开皮肤商品购买弹框
  • 具体使用案例如下:
local code  = Player:openDevGoodsSkinBuyDialog(playerid, skin, desc)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

openDevGoodsSkinDetail

  • 参数及类型:
    • playerid:number玩家Uin
    • skin:string模型ID
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开皮肤商品详情页(仅限自定义UI按钮响应事件)
  • 具体使用案例如下:
local code  = Player:openDevGoodsSkinDetail(playerid, skin)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

openDevGoodsSkin

  • 参数及类型:
    • playerid:number玩家Uin
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开皮肤商店(仅限自定义UI按钮响应事件)
  • 具体使用案例如下:
local code  = Player:openDevGoodsSkin(playerid)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

OpenInviteBulletBox

  • 参数及类型:
    • playerid:number玩家Uin
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开好友邀请界面
  • 具体使用案例如下:
local code  = Player:OpenInviteBulletBox(playerid)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

GetFirstInviter

  • 参数及类型:
    • playerid:number被邀请的玩家Uin
  • 返回值及类型:
    • code:number成功(ErrorCode.OK) ErrorCode
    • uin:number邀请人的玩家Uin(获取失败时返回错误码)
  • 该方法的主要作用: 获取玩家首次邀请人(阻塞接口,请求间隔10s)
  • 具体使用案例如下:
local code , uin = Player:GetFirstInviter(playerid)
if code == ErrorCode.OK then
    print('执行成功' , uin )
else
    print('执行失败')
end

 

GetInviteGroupS

  • 参数及类型:
    • objid:number玩家Uin
  • 返回值及类型:
    • code:number成功(ErrorCode.OK) ErrorCode
    • uins:table玩家ID的数组
  • 该方法的主要作用: 获取玩家新邀请的玩家(阻塞接口)
  • 具体使用案例如下:
local code ,uins = Player:GetInviteGroupS(playerid)
if code == ErrorCode.OK then
    print('执行成功' ,uins )
else
    print('执行失败')
end

 

OpenDevGoodsPage

  • 参数及类型:
    • objid:number玩家Uin
    • pagetype:number页面枚举值(MiniShopPage)MiniShopPage
    • pagetitle:string页面标题
  • 返回值及类型:
    • code:number成功(ErrorCode.OK)ErrorCode
  • 该方法的主要作用: 打开开发者商店页面
  • 具体使用案例如下:
local code  = Player:OpenDevGoodsPage(playerid, pagetype, pagetitle)
if code == ErrorCode.OK then
    print('执行成功'  )
else
    print('执行失败')
end

 

GetPlayerCostStatic

  • 参数及类型:
    • objid : number 玩家Uin
    • tbegin : number 开始时间的时间戳(时间戳(Unix timestamp)是指自协调世界时(UTC)的1970年1月1日00:00:00起至现在所经过的秒数。时间戳一般是一个10位数字)
    • tend : number 结束时间的时间戳
    • costtype : number 查询类型(1迷你豆 2迷你币)
  • 返回值及类型:
    • code : number 成功(ErrorCode.OK) ErrorCode
    • icount : number 消费数量
  • 该方法的主要作用: 获取玩家的消费统计(有15s冷却限制,查询失败或触发冷却返回-1)
  • 具体使用案例如下:
local code ,icount = Player:GetPlayerCostStatic(playerid, tbegin, tend, costtype)
if code == ErrorCode.OK then
    print('执行成功' ,icount )
else
    print('执行失败')
end

 

站点有内容要更新是否更新。
更新
忽略