Preparing search index...
The search index is not available
SDK Documentation - v7.0.0
SDK Documentation - v7.0.0
sdk/src/players
getPlayer
Function getPlayer
get
Player
(
user
?:
GetPlayerDataReq
)
:
null
|
GetPlayerDataRes
Returns the info of the player if it's in the scene.
Parameters
Optional
user:
GetPlayerDataReq
Returns
null
|
GetPlayerDataRes
Documentation
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
SDK
Documentation -
v7.0.0
ECS
Append
Value
Operation
Avatar
Texture
Border
Rect
Camera
Transition
Component
Data
Composite
Composite
Component
Composite
Component_
Data
Entry
Composite
Definition
Crdt
Message
Protocol
Delete
Component
Delete
Component
Network
Delete
Entity
Delete
Entity
Network
Entity
Utils
Move
PBAnimation
State
PBAnimator
PBAudio
Event
PBAudio
Source
PBAudio
Stream
PBAvatar
Attach
PBAvatar
Base
PBAvatar
Emote
Command
PBAvatar
Equipped
Data
PBAvatar
Modifier
Area
PBAvatar
Shape
PBBillboard
PBCamera
Mode
PBCamera
Mode
Area
PBColor3
PBColor4
PBEngine
Info
PBGltf
Container
PBGltf
Container
Loading
State
PBInput
Modifier
PBInput
Modifier_
Standard
Input
PBMain
Camera
PBMaterial
PBMaterial_
Pbr
Material
PBMaterial_
Unlit
Material
PBMesh
Collider
PBMesh
Collider_
Box
Mesh
PBMesh
Collider_
Cylinder
Mesh
PBMesh
Collider_
Plane
Mesh
PBMesh
Collider_
Sphere
Mesh
PBMesh
Renderer
PBMesh
Renderer_
Box
Mesh
PBMesh
Renderer_
Cylinder
Mesh
PBMesh
Renderer_
Plane
Mesh
PBMesh
Renderer_
Sphere
Mesh
PBNft
Shape
PBPlayer
Identity
Data
PBPointer
Events
PBPointer
Events
Result
PBPointer
Events_
Entry
PBPointer
Events_
Info
PBPointer
Lock
PBPosition
PBQuaternion
PBRaycast
PBRaycast
Result
PBRealm
Info
PBText
Shape
PBTween
PBTween
Sequence
PBTween
State
PBUi
Background
PBUi
Canvas
Information
PBUi
Dropdown
PBUi
Dropdown
Result
PBUi
Input
PBUi
Input
Result
PBUi
Text
PBUi
Transform
PBVector2
PBVector3
PBVideo
Event
PBVideo
Player
PBVirtual
Camera
PBVisibility
Component
Put
Component
Operation
Put
Network
Component
Operation
Raycast
Hit
Rect
Rotate
Scale
Schemas
Texture
Texture
Union
Video
Texture
Etherum
Provider
Math &
Colors
Color3
Color4
Matrix
Plane
Quaternion
Scalar
Vector2
Vector3
React
Ecs
React
Ecs
JSX
js-
runtime/apis
"~system/
Comms
Api"
"~system/
Communications
Controller"
"~system/
Engine
Api"
"~system/
Environment
Api"
"~system/
Ethereum
Controller"
"~system/
Players"
"~system/
Portable
Experiences"
"~system/
Restricted
Actions"
"~system/
Runtime"
"~system/
Scene"
"~system/
Signed
Fetch"
"~system/
Testing"
"~system/
User
Action
Module"
"~system/
User
Identity"
sdk/src/composite-
provider
sdk/src/ethereum-
provider/text-
encoder
sdk/src/ethereum-
provider/text-
encoding
sdk/src/network
sdk/src/network/binary-
message-
bus
sdk/src/network/entities
sdk/src/network/filter
sdk/src/network/message-
bus-
sync
sdk/src/network/state
sdk/src/network/utils
sdk/src/players
define
Player
Helper
get
Player
on
Enter
Scene
on
Leave
Scene
default
Returns the info of the player if it's in the scene.