Appearance
玩家模块管理接口 Player
具体函数名及描述如下:
GetHostUin
- 参数及类型: 无
- 返回值及类型:
- ret:
number
玩家Uin
- ret:
- 该方法的主要作用: 获取房主uin
- 具体使用案例如下:
lua
local uin = Player:GetHostUin()
SetGameResults
- 参数及类型:
- objid:
number
玩家Uin - result:
number
游戏结果(TeamResults)TeamResults
- objid:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 设置玩家是否胜利
- 具体使用案例如下:
lua
local result = Player:SetGameResults(Player:GetHostUin(), TeamResults.Win)
SetGameWin
lua
local result = Player:SetGameWin(Player:GetHostUin())
GetCurToolID
- 参数及类型:
- objid:
number
玩家Uin
- objid:
- 返回值及类型:
- ret:number,string道具ID
- 该方法的主要作用: 获取玩家手持道具
- 具体使用案例如下:
lua
local toolID = Player:GetCurToolID(Player:GetHostUin())
GetShotcutIndex
lua
local index = Player:GetShotcutIndex(Player:GetHostUin())
SetShotcutIndex
lua
local result = Player:SetShotcutIndex(Player:GetHostUin(), 2)
SetSkillCD
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 设置道具技能时间
- 具体使用案例如下:
lua
local result = Player:SetSkillCD(Player:GetHostUin(), 12005, 10)
ReviveToPos
lua
local result = Player:ReviveToPos(Player:GetHostUin(), x, y, z)
SetRevivePoint
lua
local result = Player:SetRevivePoint(Player:GetHostUin(), x, y, z)
NotifyGameInfo2Self
lua
local result = Player:NotifyGameInfo2Self(Player:GetHostUin(), "飘窗提示")
RotateCamera
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家旋转摄像机角度
- 具体使用案例如下:
lua
local result = Player:RotateCamera(Player:GetHostUin(), 45, 0)
ShakeCamera
- 参数及类型:
- 返回值及类型:
- ret:
boolean
操作是否成功
- ret:
- 该方法的主要作用: 抖动玩家镜头
- 具体使用案例如下:
lua
local result = Player:ShakeCamera(Player:GetHostUin(), 1, 20)
StopShakeCamera
lua
local result = Player:StopShakeCamera(Player:GetHostUin())
RotateCameraToActor
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家旋转摄像机角度朝向actor
- 具体使用案例如下:
lua
local result = Player:RotateCameraToActor(Player:GetHostUin(), objId)
ChangeViewMode
- 参数及类型:
- objid:
number
玩家Uin - viewmode:
number
视角枚举(ViewPortType)ViewPortType - islock:
boolean
是否锁定
- objid:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家改变视角
- 具体使用案例如下:
lua
local result = Player:ChangeViewMode(Player:GetHostUin(), ViewPortType.Main, false)
IsEquipByResID
- 参数及类型:
- objid:
number
玩家Uin - itemid:number,string道具类型
- objid:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家是否装备了某件装备
- 具体使用案例如下:
lua
local result = Player:IsEquipByResID(Player:GetHostUin(), 12202)
GetAimPos
- 参数及类型:
- objid:
number
玩家Uin
- objid:
- 返回值及类型: ret:x|y|z:number:坐标
- 该方法的主要作用: 获取玩家准心位置
- 具体使用案例如下:
lua
local x, y, z = Player:GetAimPos(Player:GetHostUin())
GetAimDir
lua
local ret = Player:GetAimDir(objid)
GetRayOriginPos
lua
local x|y|z = Player:GetRayOriginPos(objid)
PlayMusic
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 对玩家播放背景音乐2D
- 具体使用案例如下:
lua
local result = Player:PlayMusic(Player:GetHostUin(), 10002, 100, 1, false)
StopMusic
lua
local result = Player:StopMusic(Player:GetHostUin(), 10002)
PauseMusic
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家暂停/恢复播放背景音乐
- 具体使用案例如下:
lua
local result = Player:PauseMusic(Player:GetHostUin(), 10002, true)
OpenUIView
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 打开一个UI界面
- 具体使用案例如下:
lua
local result = Player:OpenUIView(Player:GetHostUin(), "7482986899365911542-22886")
HideUIView
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 隐藏一个UI界面
- 具体使用案例如下:
lua
local result = Player:HideUIView(Player:GetHostUin(), "7482986899365911542-22886")
GetNickname
lua
local name = Player:GetNickname(objid)
OpenDevGoodsBuyDialog
- 参数及类型:
- 返回值及类型:
- 该方法的主要作用: 打开开发者商店商品购买弹框(开发者账号和自定义按钮点击事件可用)
- 具体使用案例如下:
lua
local code = Player:OpenDevGoodsBuyDialog(objid, devGoodsId, customDesc)
OpenDevGoodsBuyDetailedDialog
- 参数及类型:
- 返回值及类型:
- 该方法的主要作用: 打开开发者商店商品详情页
- 具体使用案例如下:
lua
local code = Player:OpenDevGoodsBuyDetailedDialog(objid, devGoodsId)
OpenDevStore
lua
local ret = Player:OpenDevStore(objid)
OpenDevStoreTab
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 打开开发者商品二级分类
- 具体使用案例如下:
lua
local ret = Player:OpenDevStoreTab(objid, page, name)
OpenDevGoodsPage
- 参数及类型:
- objid:
number
玩家Uin - pagetype:
number
页面枚举值(MiniShopPage)MiniShopPage - pagetitle:
string
页面标题
- objid:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 打开开发者商店一级页面
- 具体使用案例如下:
lua
local ret = Player:OpenDevGoodsPage(playerid, pagetype, pagetitle)
GetPlayerCostStatic
- 参数及类型:
- call_back:function内部回调(缺省参数)
- playerid:
number
玩家Uin - tbegin:
number
开始时间 - tend:
number
结束时间 - costtype:
number
查询类型 MiniCurrencyMiniCurrency
- 返回值及类型:
- icount:
number
消费数量(-1 请求失败)
- icount:
- 该方法的主要作用: 获取玩家的消费统计(有5s冷却限制,触发冷却返回nil)
- 具体使用案例如下:
lua
-- 获取玩家24小时内消耗的迷你币
local result = Player:GetPlayerCostStatic(Player:GetHostUin(), os.time() - 24 * 60 * 60, os.time(), MiniCurrency.MiniCoin)
StandReportEvent
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家自定义数据上报埋点
- 具体使用案例如下:
lua
local result = Player:StandReportEvent(Player:GetHostUin(), "自动测试上报")
ClearMotion
lua
local result = Player:ClearMotion(Player:GetHostUin())
SetMobileVibrate
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家手机震动
- 具体使用案例如下:
lua
local result = Player:SetMobileVibrate(Player:GetHostUin(), 1, 20)
GetScreenSpacePos
- 参数及类型:
- 返回值及类型: retX:number:x retY:number:y
- 该方法的主要作用: 根据玩家uin,3D坐标获取玩家屏幕2D坐标,需要注意这里的X、Y、Z需要将方块坐标*100后来使用,例如原坐标为(1,7,1),则需要传入(100,700,100),之后版本会新增接口替代该接口。
- 具体使用案例如下:
lua
local screenX, screenY = Player:GetScreenSpacePos(Player:GetHostUin(), x, y, z)
SendFriendApply
lua
local result = Player:SendFriendApply(Player:GetHostUin(), friendUin)
SetCameraPosTransformTo
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家摄像机变换到位置
- 具体使用案例如下:
lua
local result = Player:SetCameraPosTransformTo(Player:GetHostUin(), {x = 0, y = 100, z = 0}, Easing.ExpoIn, 0.2)
SetCameraPosTransformBy
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家摄像机变换相对位置
- 具体使用案例如下:
lua
local result = Player:SetCameraPosTransformBy(Player:GetHostUin(), {x = 0, y = 0, z = 100}, Easing.Linear, 1)
SetCameraRotTransformBy
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家摄像机旋转相对角度
- 具体使用案例如下:
lua
-- 摄像机线性旋转,时间1秒
local result = Player:SetCameraRotTransformBy(Player:GetHostUin(), {x = 0, y = 100, z = 0}, Easing.Linear, 1)
SetCameraFovTransformBy
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家摄像机Fvo变换相对值
- 具体使用案例如下:
lua
local result = Player:SetCameraFovTransformBy(Player:GetHostUin(), 45, Easing.Linear, 1)
SetCameraAttrState
- 参数及类型:
- playerid:
number
玩家Uin - attr:
number
摄像机属性(CameraModel)CameraModel
- playerid:
- 返回值及类型:
- enable:
bool
开关(true开启 false关闭)
- enable:
- 该方法的主要作用: 设置玩家的摄像机设置开关
- 具体使用案例如下:
lua
local result = Player:SetCameraAttrState(Player:GetHostUin(), CameraModel.MoveFollow, true)
SetCameraRotMode
- 参数及类型:
- 返回值及类型:
- code:
bool
成功(true)
- code:
- 该方法的主要作用: 设置玩家的摄像机旋转模式
- 具体使用案例如下:
lua
local result = Player:SetCameraRotMode(Player:GetHostUin(), CameraRotate.AllDir)
SetCameraMountObj
- 参数及类型:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 设置玩家的摄像机挂载到对象
- 具体使用案例如下:
lua
local result = Player:SetCameraMountObj(Player:GetHostUin(), playerUin)
SetCameraMountPos
lua
local result = Player:SetCameraMountPos(Player:GetHostUin(), {x = x, y = y, z = z})
ResetCameraAttr
lua
local result = Player:ResetCameraAttr(Player:GetHostUin())
OpenBoxByPos
lua
local result = Player:OpenBoxByPos(Player:GetHostUin(), x, y, z)
GetFirstInviter
- 参数及类型:
- call_back:function内部回调(缺省参数)
- objid:
number
被邀请的玩家Uin
- 返回值及类型:
- uin:
number
邀请人的玩家Uin(获取失败时返回错误码)
- uin:
- 该方法的主要作用: 获取玩家首次邀请人(阻塞接口,请求间隔10s)
- 具体使用案例如下:
lua
local inviterUin = Player:GetFirstInviter(Player:GetHostUin())
HasFriend
- 参数及类型:
- 返回值及类型:
- code:
bool
是否是好友
- code:
- 该方法的主要作用: 判断两个玩家是否是好友(阻塞接口)
- 具体使用案例如下:
lua
local result = Player:HasFriend(Player:GetHostUin(), "123456")
GetMiniVipLevel
lua
local level = Player:GetMiniVipLevel(Player:GetHostUin())
ChangPlayerMoveType
- 参数及类型:
- 返回值及类型:
- success:
bool
成功
- success:
- 该方法的主要作用: 改变玩家移动方式
- 具体使用案例如下:
lua
local result = Player:ChangPlayerMoveType(Player:GetHostUin(), MoveType.Flying)
PlayAdvertising
- 参数及类型:
- 返回值及类型:
- 该方法的主要作用: 触发器播放广告接口
- 具体使用案例如下:
lua
local result = Player:PlayAdvertisingCallback(Player:GetHostUin(),'测试广告' ,function(code, adname)
if code == ErrorCode.OK then
print("广告播放成功")
else
print("广告播放失败")
end
end)
OpenInnerView
- 参数及类型:
- uin:
number
玩家Uin - iview:
number
弹窗类型枚举(InnerPopUpview)InnerPopUpview - bopen:
bool
打开或者关闭 - data:any根据前面枚举传参(储物箱需要传入位置)
- uin:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 玩家组显示游戏内弹窗
- 具体使用案例如下:
lua
local result = Player:OpenInnerView(Player:GetHostUin(), InnerPopUpview.InviteFriend, true)
local result2 = Player:OpenInnerView(Player:GetHostUin(),InnerPopUpview.StorageBox, true,{x=0,y = 7,z = 0}) -- 打开坐标(0 7 0)位置的储物箱
SetItemAttAction
- 参数及类型:
- objid:
number
玩家ID - itemid:number,string道具ID
- atttype:
number
掉落属性枚举 ItemAbilityItemAbility - switch:
boolean
是否打开
- objid:
- 返回值及类型:
- ret:
bool
成功(true)
- ret:
- 该方法的主要作用: 设置玩家道具设置属性
- 具体使用案例如下:
lua
local result = Player:SetItemAttAction(Player:GetHostUin(), 10025, ItemAbility.Drop, true)
ForceOpenBoxUI
- 参数及类型:
- 返回值及类型:
- code:
bool
成功(true)
- code:
- 该方法的主要作用: 玩家强制打开UI界面
- 具体使用案例如下:
lua
local result = Player:ForceOpenBoxUI(Player:GetHostUin(), WorkStage.Repair)
ItemSkillCDEnter
- 参数及类型:
- objid:
number
玩家Uin - itemid:number/string道具ID
- cd:number/nilCD
- objid:
- 返回值及类型:
- ret:
boolean
操作是否成功
- ret:
- 该方法的主要作用: 设置道具技能进入冷却
- 具体使用案例如下:
lua
local result = Player:ItemSkillCDEnter(Player:GetHostUin(), 12005)
ItemSkillCDDone
- 参数及类型:
- objid:
number
玩家Uin - itemid:number/string道具ID
- objid:
- 返回值及类型:
- ret:
boolean
操作是否成功
- ret:
- 该方法的主要作用: 设置道具技能结束冷却
- 具体使用案例如下:
lua
local result = Player:ItemSkillCDDone(Player:GetHostUin(), 12005)
SetGunActionState
- 参数及类型:
- 返回值及类型:
- ret:
boolean
操作是否成功
- ret:
- 该方法的主要作用: 设置玩家枪械权限
- 具体使用案例如下:
lua
local result = Player:SetGunActionState(Player:GetHostUin(), GunActionBan.AimFire, true)
GetViewMode
lua
local ret = Player:GetViewMode(uin)
GetRevivePoint
lua
local x|y|z = Player:GetRevivePoint(uin)
GetRentCloudServerOwner
- 参数及类型: 无
- 返回值及类型:
- uin:
number
玩家Uin (仅租赁云服生效)
- uin:
- 该方法的主要作用: 获取租赁云服务器服主
- 具体使用案例如下:
lua
local uin = Player:GetRentCloudServerOwner()