Options
All
  • Public
  • Public/Protected
  • All
Menu

@akashic-extension/coe

Index

Type aliases

COEMessage

COEMessage: COEChildSessionStartMessage | COEExtendChildSessionEndMessage | COEEndMessage

Variables

Const TrustedPlayerId

TrustedPlayerId: ":akashic" = ":akashic"

Let debugMode

debugMode: boolean = false

Const joinedPlayerIds

joinedPlayerIds: string[] = []

Let localSessionCount

localSessionCount: number = 0

Let roles

roles: string[] = []

window

window: any

Functions

addJoinedPlayer

  • addJoinedPlayer(playerId: string): void
  • JoinされたPlayer IDをリストに追加する。

    Parameters

    • playerId: string

      追加するPlayer ID

    Returns void

exit

  • exit(result?: any): void
  • 本共体験セッションを終了する。

    Parameters

    • Optional result: any

      本共体験セッションの結果。 このメソッド呼び出し後、 send プラグイン経由で本値を含めた終了メッセージがシステム側に通知される。 本値が null または undefined である場合、結果はなかったものとして取り扱われる。

    Returns void

exitSession

  • exitSession(sessionId: SessionId, parameters?: COEExitSessionParameters): void
  • coe-plugin 経由で共体験セッションのUI表示を終了する。

    Parameters

    • sessionId: SessionId

      その共体験セッションを一意に識別するためのID

    • Optional parameters: COEExitSessionParameters

      UI表示を終了に伴う追加処理を格納する情報

    Returns void

getDebugMode

  • getDebugMode(): boolean

getPermission

getSessionId

  • getSessionId(): SessionId

handleJoinEvent

  • handleJoinEvent(e?: g.JoinEvent): void

handleLeaveEvent

  • handleLeaveEvent(e?: g.LeaveEvent): void

hasRole

  • hasRole(roll: string): boolean

initialize

isJoinedPlayer

  • isJoinedPlayer(playerId: string): boolean

isSandbox

  • isSandbox(): boolean

isTrustedAction

  • isTrustedAction(action: Action<any>): boolean
  • 信頼されているシステムからの action であるかを返す。

    Parameters

    • action: Action<any>

      アクション

    Returns boolean

removeJoinedPlayer

  • removeJoinedPlayer(playerId: string): void
  • JoinされたPlayer IDをリストから削除する。

    Parameters

    • playerId: string

      削除するPlayer ID

    Returns void

startLocalSession

startSession

  • startSession(parameters: COEStartSessionParameters): void
  • coe-plugin 経由で共体験セッションを開始する。

    Parameters

    • parameters: COEStartSessionParameters

      開始する共体験セッションの起動情報

    Returns void

Object literals

Const permission

permission: object

advance

advance: false = false

advanceRequest

advanceRequest: false = false

aggregation

aggregation: false = false

Generated using TypeDoc