剧情动画模块管理接口 Timeline

具体函数名及描述如下:

序号	函数名	函数描述
1	PlayForAll(...)	对所有玩家播放Timeline
2	PlayForPlayer(...)	对指定玩家播放Timeline
3	Pause(...)	暂停指定玩家的Timeline播放
4	Resume(...)	恢复指定玩家的Timeline播放
5	SkipForPlayer(...)	跳过指定玩家当前正在播放的Timeline
6	GetPlayerState(...)	获取玩家Timeline播放状态
7	IsAllFinished(...)	检查所有玩家是否都已播放完成指定Timeline

PlayForAll

• 参数及类型：
  • timelineId:string Timeline 资源id
  • refKind:number 播放参考 0使用默认/1指定位置与旋转/2指定玩家
  • anchorPos:table 锚点位置cm(kind=1/2)
  • anchorYaw:number 锚点朝向度(kind=1/2)
• 返回值及类型：
  • code:number 返回(参考系错位为负 TIMELINE_PLAY_REJECT_*，否则 0)
• 该方法的主要作用： 对所有玩家播放Timeline
• 具体使用案例如下：

local code = Timeline:PlayForAll(timelineId, refKind, anchorPos, anchorYaw)

PlayForPlayer

• 参数及类型：
  • uin:number 玩家UIN
  • timelineId:string Timeline 资源id
  • reverse:boolean 是否反向播放
  • playToEnd:boolean 是否播放到结尾
  • refKind:number 播放参考 0使用默认/1指定位置与旋转/2指定玩家
  • anchorPos:table 锚点位置cm(kind=1/2)
  • anchorYaw:number 锚点朝向度(kind=1/2)
• 返回值及类型：
  • code:number 返回(参考系错位为负 TIMELINE_PLAY_REJECT_*，否则 0)
• 该方法的主要作用： 对指定玩家播放Timeline
• 具体使用案例如下：

local code = Timeline:PlayForPlayer(uin, timelineId, reverse, playToEnd, refKind, anchorPos, anchorYaw)

Pause

• 参数及类型：
  • uin:number 玩家UIN
  • timelineId:string Timeline 资源id
• 返回值及类型：
  • code:boolean 成功(true)
• 该方法的主要作用： 暂停指定玩家的Timeline播放
• 具体使用案例如下：

local code = Timeline:Pause(uin, timelineId)

Resume

• 参数及类型：
  • uin:number 玩家UIN
  • timelineId:string Timeline 资源id
• 返回值及类型：
  • code:boolean 成功(true)
• 该方法的主要作用： 恢复指定玩家的Timeline播放
• 具体使用案例如下：

local code = Timeline:Resume(uin, timelineId)

SkipForPlayer

• 参数及类型：
  • uin:number 玩家UIN
• 返回值及类型：
  • code:boolean 成功(true)
• 该方法的主要作用： 跳过指定玩家当前正在播放的Timeline
• 具体使用案例如下：

local code = Timeline:SkipForPlayer(uin)

GetPlayerState

• 参数及类型：
  • uin:number 玩家UIN
  • timelineId:string Timeline 资源id
• 返回值及类型：
  • state:number 播放状态(0空闲 1播放中 2暂停)
• 该方法的主要作用： 获取玩家Timeline播放状态
• 具体使用案例如下：

local state = Timeline:GetPlayerState(uin, timelineId)

IsAllFinished

• 参数及类型：
  • timelineId:string Timeline 资源 id
• 返回值及类型：
  • code:boolean 全部完成(true)
• 该方法的主要作用： 检查所有玩家是否都已播放完成指定Timeline
• 具体使用案例如下：

local code = Timeline:IsAllFinished(timelineId)