cn.leancloud.play.plugin.context

Interface Context<T extends RoomRequest>

All Known Subinterfaces:

DeferableContext<T>, SkipableContext<T>

All Known Implementing Classes:

BeforeJoinRoomContext, BeforeLeaveRoomContext, BeforeSendEventContext, BeforeSetPlayerPropertiesContext, BeforeSetRoomPropertiesContext, BeforeSetRoomSystemPropertiesContext, CreateRoomContext, DestroyRoomContext

public interface Context<T extends RoomRequest>

每个 Hook 被调用时都会传入一个 Context。Context 内封装着 Hook 的名称、触发 Hook 调用的玩家 请求参数，以及当前 Hook 请求的处理状态。Hook 处理结果也是通过 Context 通知给 Game Server。可以将 Context 当做 Hook 与 Game Server 之间通信、交互的桥梁。

Method Summary

Modifier and Type	Method and Description
void	continueProcess() 同意本次请求，Game Server 会执行 Hook 之后的操作
String	getHookName() 获取当前 Context 所属 Hook 名称
T	getRequest() 获取与当前 Context 绑定的 Hook 请求参数实例
ContextStatus	getStatus() 获取当前 Context 状态
boolean	isProcessed() 当前 Hook 请求是否已经被处理过，即状态为 CONTINUED, SKIPPED, REJECTED
void	rejectProcess(Reason reason) 拒绝本次请求，并发送 Reason 信息给发送请求的玩家

Method Detail

getStatus

ContextStatus getStatus()

获取当前 Context 状态

Returns:

Context 状态

getRequest

T getRequest()

获取与当前 Context 绑定的 Hook 请求参数实例

Returns:

Hook 请求参数实例

getHookName

String getHookName()

获取当前 Context 所属 Hook 名称

Returns:

Hook 名称

isProcessed

boolean isProcessed()

当前 Hook 请求是否已经被处理过，即状态为 CONTINUED, SKIPPED, REJECTED

Returns:

Hook 请求是否已经被处理过

continueProcess

void continueProcess()

同意本次请求，Game Server 会执行 Hook 之后的操作

rejectProcess

void rejectProcess(Reason reason)

拒绝本次请求，并发送 Reason 信息给发送请求的玩家

Parameters:

reason - 拒绝原因