Class RpcContext

Global context set during RPC invocation.

Note

Provides access to the calling connection and allows setting a return value. The context is only valid during the RPC handler execution.

Index

Constructors

Accessors

callId connectionId context objectId returnValueAsyncOp scene sceneNodeManager scope

Methods

Constructors

constructor

new RpcContext(): RpcContext
Returns RpcContext

Accessors

`Static`callId

get callId(): number
Gets the unique ID of this RPC call.

Returns number
The call ID.

`Static`connectionId

get connectionId(): number
Gets the ID of the connection that sent this RPC.

Returns number
The sender connection ID, or kNetConnectionIdInvalid for local calls.

`Static`context

get context(): NetSessionContext
Gets the session context for this RPC call.

Returns NetSessionContext
The session context.

`Static`objectId

get objectId(): number
Gets the target instance's NetObjectId.

Returns number
The target NetObjectId.

`Static`returnValueAsyncOp

get returnValueAsyncOp(): UncertainAsyncOp<DataStream, string>
Gets the return value if one was set.

Returns UncertainAsyncOp<DataStream, string>
The return value payload, or nullptr if none was set.
set returnValueAsyncOp(value): void
Parameters
- value: UncertainAsyncOp<DataStream, string>
Returns void

`Static`scene

get scene(): SceneInstance
Gets the active scene from the session context.

Returns SceneInstance
The active scene, or nullptr if no scene is active.

`Static`sceneNodeManager

get sceneNodeManager(): SceneNodeManager
Gets the SceneNodeManager from the active scene.

Returns SceneNodeManager
The SceneNodeManager, or nullptr if no scene is active.

`Static`scope

get scope(): EnumValue<RpcScope, number>
Gets the scope of this RPC.

Returns EnumValue<RpcScope, number>
The RPC scope.

Methods

`Static`hasReturnValue

hasReturnValue(): boolean
Checks if a return value was set.

Returns boolean
True if a return value was set, false otherwise.