API reference
Abilities
Section titled “Abilities”- AbilityCastState
- AbilityKind
- TargetMode
- AbilityBarProps
- AbilityBase
- AbilityDamage
- AbilityGrant
- AbilityInspection
- AbilityRefusal
- AbilityRow
- AbilitySlow
- AbilityTargetReading
- AreaAbility
- CastAimWindow
- CastControls
- ChainAbility
- CharacterSlow
- ProjectileAbility
- RolledDamage
- SpellBeamEnds
- SpellBeamProps
- SpellImpact
- SpellLookProps
- SpellRingProps
- SpellRunesProps
- SpellShardsProps
- SpellSpearProps
- SpellSwirlProps
- TargetCheck
- TargetingProps
- TargetingSettings
- AbilitySettings
- FactionColors
- SpellEffects
- SpellPart
- SpellParts
- TargetRefusalOf
- TargetState
- AbilitiesTrait
- AbilityProjectileTrait
- approachShare
- CastingTrait
- castRefusalText
- CastRefusedEvent
- castReservation
- castTurnSeconds
- globalCooldown
- PendingCastTrait
- SpellLandedEvent
- SpellStruckEvent
- TargetableTrait
- TargetTrait
- AbilityBar
- checkTarget
- createCastPayload
- createGlowMaterial
- cycleTarget
- describeCastRefusal
- findClickedTarget
- findTargetsInFront
- grantAbilities
- hasLineOfSight
- holdsAbility
- nameAbilityCooldown
- pinTarget
- readAbilityInspection
- registerAbility
- revokeAbilities
- rollAbilityDamage
- slowCharacter
- SpellBeam
- SpellLook
- SpellRing
- SpellRunes
- SpellShards
- SpellSpear
- SpellSwirl
- strikeTarget
- Targeting
- updateTarget
- useCast
- useTarget
- watchCastRefusals
Animation
Section titled “Animation”- ClipLayer
- PlayClipOptions
- PosedModel
- RegisterClipOptions
- AfterPoseCallback
- ClipMarkRecord
- ClipMarks
- StopClipOptions
- ClipMarkEvent
- OneShotClipTrait
- UpperBodyClipTrait
- playClip
- registerClip
- stopClip
- useAfterPose
- useClipMark
Camera
Section titled “Camera”- BodyNearEye
- CameraPreset
- CameraTarget
- CameraFieldOfView
- CameraFraming
- CameraKnobs
- CameraProps
- CameraRigOptions
- CameraShakeOptions
- ChaseCameraProps
- CursorState
- SideCameraProps
- CameraSettings
- CameraTuning
- cameraShakeSettings
- CameraShakeTrait
- useCursor
- Camera
- ChaseCamera
- frameCamera
- FreeCamera
- MapCamera
- shakeCamera
- SideCamera
- useCamera
- useFreeCursor
Character
Section titled “Character”Commands
Section titled “Commands”- CommandFieldKind
- CommandLifetime
- CommandRefusal
- CommandSettler
- CommandStatus
- Refusal
- CommandCause
- CommandDeclaration
- CommandHandle
- CommandOptions
- CommandTimelineEntry
- DumpedCommands
- DumpedLineage
- DumpedPendingCommand
- DumpedQueuedCommand
- DumpedReceipt
- EntityFieldOptions
- Vector3FieldOptions
- CommandDeclarations
- CommandField
- CommandFields
- CommandOutcome
- CommandReceipt
- CommandResult
- PageCommandFigures
- PageValueOf
- PayloadOf
- ReadCommand
- ReadPayloadOf
- RefusalOf
- ReturnField
- ReturnFields
- SendCommandOptions
- SettledCommandResult
- WireRecord
- WireValue
- WriteCommandOptions
- commandAheadTicks
- commandRefusalLines
- defaultCommandBurst
- defaultCommandsPerSecond
- defaultCommandTimeoutSeconds
- defaultLateTicks
- defaultPredictedCommandsPerSecond
- maximumEntityKeyLength
- maximumPayloadBytes
- maximumPredictedPerTick
- maximumReturnBytes
- mostCommandBurst
- mostCommandsPerSecond
- mostCommandTimeoutSeconds
- mostLateTicks
- boolean
- controlled
- defineCommand
- entities
- entity
- findCommandResult
- integer
- isVisibleTo
- list
- number
- oneOf
- readCommands
- readCommandTimeline
- readPageCommandFigures
- sendCommand
- useCommandResults
- useLatestCommandResult
- vector3
- writeCommand
Cooldowns
Section titled “Cooldowns”- Cooldown
- CooldownStart
- CooldownKey
- CooldownsTrait
- defineCooldown
- isCoolingDown
- readCooldown
- startCooldown
- useCooldown
Devtools
Section titled “Devtools”- PanelButton
- PanelCustom
- PanelNumberField
- PanelTextField
- PanelToggleField
- DevtoolsPanelSchema
- PanelEntry
- PanelField
- PanelReadout
- button
- custom
- useDevtoolsPanel
- useInspect
Entity
Section titled “Entity”- AttachRefusal
- DamageRefusal
- EventDelivery
- EventScope
- PlaceholderShape
- PointerButton
- ShotJudge
- WeaponKind
- WeaponNumber
- WhenAbsent
- Track
- AttachOptions
- Behaviour
- BehaviourConfig
- BobProps
- ChaseProps
- Damage
- DamagedRecord
- DisplayNameProps
- EmitRecipientOptions
- EventHandle
- FiredShot
- FiredShotRecord
- HealthProps
- Hit
- HitZone
- InstancedModelProps
- InstancePlacement
- InteractProps
- MeasuredLatency
- ModelFileProps
- ModelRegistration
- NearestControlledSearch
- PickupProps
- PredictedComparison
- PredictedModifier
- PredictedQuery
- PredictedTrait
- RespawnProps
- RewindBounds
- RewindSend
- SendsAround
- ShotCheck
- ShotCredit
- ShotHit
- ShotRefusal
- ShotResult
- ShotSettings
- SpawnOptions
- SpinProps
- TrackFrame
- TrackMoverProps
- TrackOptions
- TrackPoint
- TrackSpot
- TrackTriggerProps
- Transform
- TriggerProps
- WeaponProps
- WeaponSettings
- DeepReadonly
- EmitCauseOptions
- EmitEventOptions
- EmittedEvent
- EngineQueryParameter
- EntityField
- EntityProps
- EulerAngles
- EventEntitiesOptions
- EventOptions
- EventRecord
- Heal
- Healing
- HitData
- ModelMaterial
- PositionInput
- PredictedEntity
- PredictedTolerance
- PredictedTuple
- Prefab
- PrefabOptions
- ReadEventsResult
- ReadonlyQuaternion
- ReadonlyVector2
- ReadonlyVector3
- RecordsOf
- RotationInput
- ScaleInput
- ShotRule
- ShotRules
- SpawnedEntity
- TraitOptions
- WeaponStats
- AttachmentTrait
- ChaseExitedEvent
- ChaseReachedEvent
- createAdded
- createChanged
- createRemoved
- DamagedEvent
- DiedEvent
- DisplayNameTrait
- FiredShotsTrait
- HealedEvent
- heldRule
- HeldWeaponsTrait
- HitZonesTrait
- InteractedEvent
- InvulnerableTrait
- LatencyTrait
- maximumHeldEventBytes
- maximumHeldEvents
- maximumUnreadSteps
- Not
- Or
- PrefabTrait
- rewindCeilingSeconds
- RewindTrait
- ShotJudgedEvent
- TakenEvent
- TrackMoverTrait
- TrackRefTrait
- TrackTriggerMoversTrait
- TrackTriggerTrait
- addCoins
- attach
- beginDefinitionReload
- Bob
- Chase
- claimShotHits
- createQuery
- createTrackFrame
- createTransform
- dealDamage
- dealHealing
- defineBehaviour
- defineEvent
- definePrefab
- defineTrait
- destroy
- detach
- DisplayName
- emitEvent
- Entity
- findNearestControlled
- findRewindSends
- findWalletHolder
- Health
- holdsWeapon
- InstancedModel
- Interact
- launchTrackMover
- measureLatency
- ModelFile
- onTraitChange
- originRule
- Pickup
- rateRule
- readCoins
- readCreditedCoins
- readDisplayName
- readEvents
- readModel
- readPastPlace
- readPastTraits
- readSentPlace
- readSentZones
- readTrait
- readWeaponNumber
- registerModel
- registerShotSettings
- Respawn
- rewindRule
- rewindStep
- spawn
- spawnLocal
- spendCoins
- Spin
- TrackMover
- TrackTrigger
- Trigger
- useBehaviour
- useDisplayName
- useEntity
- useEvent
- useHealth
- Weapon
- LoadingProblemKind
- LoadingStage
- MicrophoneAccess
- ShadowType
- ActionListener
- AuthoritativeStep
- Authority
- ClientStep
- EntityAuthority
- GameLoadingScreenProps
- GameProps
- InputChange
- InputState
- LoadingProblem
- LoadingScreenOptions
- LoadingState
- PlayerVoice
- QualityOptions
- QualitySettings
- QualityStore
- ReadonlyStore
- RendererDefaults
- RespawnScreenProps
- StepInput
- TimeState
- VoiceSessionState
- VoiceState
- WalletState
- AuthoritativeSystem
- GameCanvasState
- GameRenderer
- OcclusionQuality
- PredictedStep
- PredictedSystem
- QualityStart
- RendererFactory
- RendererOptions
- System
- SystemStep
- UnpredictedStep
- defaultRandomSeed
- engineStartLevels
- mapPreviewScene
- useInput
- useLoading
- useTime
- useVoice
- useVoiceSession
- useWallet
- WorldRandomTrait
- checkEntityAuthority
- findAuthority
- findEntity
- Game
- isAuthoritative
- isRoomWorld
- listenToAction
- LoadingScreen
- random
- randomInt
- randomRange
- readAuthorityWorld
- readEach
- readField
- readInput
- readInputChanges
- readLocalCharacter
- readRoomSeconds
- readWorldTick
- reloadScene
- requireAuthority
- RespawnScreen
- seedRandom
- setInput
- shuffle
- updateEach
- useAction
- useActionHeld
- useActiveQualityLevel
- useCharacter
- useControlled
- usePlayer
- usePlayerByPresence
- usePlayerVoice
- useQualityLevel
- useQualitySettings
- useQualityStore
- useScenes
- useSpeaking
- useTrait
- useUnscaledFrame
- useViewTarget
Internals
Section titled “Internals”- ClientMessageType
- ConnectionNotice
- DeviceClass
- DevtoolsAction
- DevtoolsNodeKind
- LogLevel
- MeasureKind
- MoverKind
- PlaceableKind
- PoseState
- QualityGroup
- QualityLevel
- RoomDrop
- RoomMessageType
- RoomStatus
- RunContext
- SendOutcome
- StrafeClip
- TextChannelKind
- ThumbnailFraming
- TurnSide
- VoiceMode
- VoiceOff
- WireFormat
- SkinnedBatch
- ActorMotion
- AimedShot
- ArmAngles
- ArmColliderRadii
- ArmColliders
- ArmSpread
- AttachedGame
- AxisSides
- BakeObstaclesOptions
- BehaviourOption
- BodyVelocity
- BooleanCommandField
- BotDanger
- BotInput
- BotSkill
- BotTurn
- BotWeapon
- BuildMismatchReason
- CameraAim
- CaptureOptions
- CaptureOverlays
- CaptureStack
- CharacterBotTurn
- ChaseTargetFilter
- CommandsMessage
- ComposedPlugin
- ComposedSystem
- ControlledCommandField
- CoverTest
- Daylight
- DescribeOptions
- DeviceReading
- DevtoolsNode
- DevtoolsPanel
- DevtoolsPanelIconProps
- DevtoolsState
- DevtoolsView
- DialogChoice
- DialogNode
- DynamicResolution
- EditMessage
- EntitiesCommandField
- EntityCommandField
- EntityDescription
- EntityRenderer
- GroundHeight
- HandGrip
- HeadlessGame
- HeadlessGameOptions
- JointBroken
- JointMotorRecord
- JointReaction
- JointRecord
- ListCommandField
- LoadingScreenProps
- LogLine
- Look
- LookBackground
- LookEnvironment
- LookFog
- LookGrading
- LookImage
- MapPalette
- ModifierTotals
- MountedScene
- MoverRecords
- NavMeshHandle
- NpcSpawn
- NumberCommandField
- ObstacleBody
- OneOfCommandField
- OriginRuleOptions
- PathQuery
- PelletFan
- PhysicsActor
- PhysicsHandle
- Placeable
- PlacementDescription
- PlanRing
- PlayerHooks
- PlayerTextCommandField
- PlayInput
- PlayScope
- PlayTime
- ProjectileLaunch
- PropEdit
- PropRange
- RateRuleOptions
- ReadEventOptions
- RecastLibrary
- RecordedFrame
- RelatedEntity
- Relation
- ReplicasProps
- RespawnDeclaration
- RewindHistory
- RoomFailedReason
- RoomFullReason
- RoomNotice
- RoomOptions
- RoomSettings
- RoomState
- SaveRefusalReason
- ScatterMatrixOptions
- ScatterPlacement
- SceneBot
- SceneProps
- ScenesState
- SceneTimeline
- ScreenRect
- SentMessage
- SetColliderOptions
- SettingsState
- SetVoiceOptions
- SetVoxelOptions
- ShotAim
- ShotClaimAim
- ShotMessage
- ShotRefusedMessage
- ShotSend
- ShotTest
- SkinnedBatchOptions
- SkinnedBatchPart
- SkinnedCopy
- SkinnedCopyPart
- SlideRecord
- StatEdit
- StateDump
- StepOptions
- StepSystem
- StepTimes
- StreamedFeet
- Strike
- StrokeRun
- SweepRecord
- SystemEntry
- TargetSearch
- ThumbnailOptions
- TimelineSample
- TrackScatterCopy
- TrackScatterOptions
- TrackScatterPlacement
- TrackScatterRow
- TrackSectionPoint
- TrackSurfaceOptions
- TrackTerrain
- TransformOptions
- UseSkinnedBatchOptions
- Vector3CommandField
- ViewCaptureOptions
- VrmMeasurements
- Wiki
- WikiEntry
- WikiKind
- WikiKindSummary
- WikiRef
- ActsThroughOf
- AnyCommandHandle
- AnyPredictedHandle
- AnyRoomHandle
- AvatarName
- BotPoint
- CaptureComposer
- CastPayload
- CastRefusalDetails
- CharacterCapsule
- CharacterController
- CharacterOverlay
- CharacterRecord
- CharacterSpawnPose
- ChaseTargetTest
- CommandHandles
- ConnectionText
- DaylightSettings
- DeclaredRefusalOf
- DisabledActions
- Disposer
- EntityFieldsOptions
- FieldPageValue
- FieldReadValue
- FieldSendValue
- FixedQualityLevel
- GroundSurface
- HandleOf
- HeadlessScene
- HeldItemRotation
- InputContextHandles
- InputHandles
- ListItemField
- LoadedModel
- LookPick
- MapName
- ModelLoaderExtension
- ModelName
- MovementIntent
- MovementSettings
- MoverRecord
- NoCommands
- NoInputContexts
- NoInputs
- NoPageActions
- PageActionHandles
- PageValue
- Position
- PredictedDraw
- ProjectileSettings
- QualityLevelOverrides
- ReadPayload
- RegistryTrait
- ReplicaOverlay
- ReservedAmounts
- ReturnOf
- RoomPlayers
- RoomSendRate
- SceneName
- SendPayload
- ShadowBox
- SkinnedBatchUniform
- SkinnedBatchUniforms
- Snapshot
- StateTag
- TimelineMeasure
- TimelineValue
- WaitSeconds
- AiTrait
- AuthorityTrait
- AvatarTrait
- BobTrait
- cameraSettings
- CameraTrait
- castCommand
- CharacterCapsuleTrait
- characterMotion
- characterMovementSettings
- chaserCollisionMask
- ChaseTargetsTrait
- ChaseTrait
- connectionNoticeText
- crtFragment
- DamageSourceTrait
- DayClockTrait
- daylightSettings
- defaultCharacterCapsule
- defaultCharacterController
- defaultProjectileSpeed
- defaultRoomPlayers
- defaultRoomSendRate
- DevWorldTrait
- DisarmedTrait
- DownedTrait
- DrawnFeetTrait
- energyOrbFragment
- extendGltfLoader
- extendVrmLoader
- fixedStepSeconds
- FromWelcomeTrait
- gameInsetLengths
- gizmoUserData
- groundTextures
- GroundTrait
- HealthTrait
- HullPointsTrait
- InputTrait
- InWorldTrait
- keptLags
- keptTextChatMessages
- kickedCloseCode
- lateEdgeTicks
- leastRoomPlayers
- leftCloseCode
- loadRapier
- loadRecast
- LootLeftTrait
- menuPane
- messageTooLargeCloseCode
- ModelTrait
- mostRoomPlayers
- MovementTrait
- NavMeshTrait
- NetworkEntitiesTrait
- NetworkIdTrait
- ObstaclesTrait
- openingModels
- PathTrait
- pendingStandSeconds
- PickupTrait
- playerVolumeRange
- portalFragment
- PoseTrait
- positiveY
- PreviousTransformTrait
- RefTrait
- RespawningTrait
- RespawnTrait
- roomFailedCloseCode
- roomSendRates
- saveNewerCloseCode
- saveNotLoadedCloseCode
- scatterModels
- ScatterRefTrait
- ScatterTrait
- ScenePathTrait
- SpawnPointsTrait
- SpinTrait
- SteerTrait
- StepProfileTrait
- StuckTrait
- SystemReadsTrait
- trackCameraSettings
- TransformTrait
- TriggerTrait
- TurnTrait
- useDevtools
- useRoom
- VelocityTrait
- wadeDepth
- WalletTrait
- waterFragment
- WeaponsTrait
- WelcomesTrait
- addModifierTotals
- aimAlongTrack
- aimShot
- applyModifierTotals
- applyPaintStroke
- applyTerrainStroke
- attachDevtools
- bakeGroundObstacles
- beginPaintStroke
- beginTerrainStroke
- buildTrackSurface
- calculateDaylight
- captureEntity
- captureInstance
- captureScreen
- captureView
- CharacterAnimationView
- CharacterView
- checkRespawn
- clearModifierTotals
- clearSentShots
- composeScatterMatrix
- createGameWorld
- createGroundSurface
- createHeadlessGame
- createMoverRecords
- createSweepRecord
- declareMoveSpeed
- declareRespawn
- describeSystem
- dumpKey
- dumpState
- fanPellet
- filterChaseTargets
- findDrawnTarget
- findPath
- findRayHit
- focusCamera
- followGround
- hash32
- hashKeys
- HeightfieldGeometry
- holdInput
- Hud
- isBoostHeld
- isCursorCaptured
- isLocallyControlled
- isRemote
- listMotionUrls
- listMountedMaps
- measureMiss
- measureShotDistance
- mountHeadlessScene
- nameMap
- pickEntity
- placeCharacter
- placeSpawnPoints
- placeTrackScatter
- prepareVrm
- quaternionToYaw
- raiseHeightfield
- readAimAt
- readAxisSides
- readModelSilhouette
- readModelSize
- readRoomFailedReason
- readRoomNotice
- readSaveRefusalReason
- readStepProfile
- readStrafe
- readTimeline
- recordPreviousTransforms
- recordRefusedShot
- recordSentShot
- registerWeapon
- Replicas
- roundTo
- scaleZoneDamage
- Scene
- selectCustomQuality
- selectNextQualityLevel
- sendPlayerInput
- setRewindStep
- sizeArmColliders
- spawnNpc
- spawnNpcBody
- steerFromStick
- stepSeconds
- stepWorld
- takeStepWindow
- teleportActor
- trackMovementKeys
- trackResource
- useEntityRef
- useHeadless
- useKtx2
- useModel
- VrmView
- walkTo
- weighPlanRings
- writeStateTags
- yawToQuaternion
Inventory
Section titled “Inventory”- EquipmentSlot
- ItemEffectType
- BagProps
- CoinsEffect
- HealEffect
- InventoryProps
- InventoryState
- ItemActivation
- ItemData
- ItemDefinition
- ItemDrop
- ItemEquip
- ItemStack
- ItemUse
- LockProps
- LootProps
- ModifyEffect
- StackMove
- StackSplit
- ItemEffect
- ItemModifier
- ItemTargetTrait
- SavedEquipment
- SavedInventory
- WornItems
- EquipmentTrait
- InventoryTrait
- ItemAcceptedEvent
- itemStack
- LockTrait
- LootTrait
- useInventory
- activateItem
- addItem
- Bag
- countItem
- declareInventory
- dropItem
- equipItem
- Equipment
- hasItem
- Inventory
- Lock
- Loot
- moveStack
- registerItem
- registerItemTarget
- removeItem
- restoreEquipment
- restoreInventory
- splitStack
- unequipItem
- useItemCount
Levels
Section titled “Levels”- LevelBannerProps
- LevelsStatus
- LevelStatus
- Register
- LevelBest
- LevelId
- defineLevels
- finishLevel
- LevelBanner
- listLevels
- nextLevel
- playLevel
- restoreLevels
- useLevelPlace
- useLevels
Materials
Section titled “Materials”- CrtMaterialProps
- EnergyOrbMaterialProps
- PortalMaterialProps
- WaterMaterialProps
- CrtMaterial
- EnergyOrbMaterial
- PortalMaterial
- WaterMaterial
- Faction
- NpcEvent
- DialogBuilder
- DialogNodeBuilder
- Routine
- RoutinesBuilder
- ChoiceOptions
- ConversationChoice
- DialogPanelProps
- DialogProps
- DialogTree
- NamedRoute
- Routines
- Talk
- WalkOptions
- DialogValue
- DialogValues
- GiveUpReason
- NpcProps
- Route
- RoutePoint
- ConversationTrait
- GaveUpEvent
- TalkingTrait
- describeRoutines
- dialog
- Dialog
- DialogPanel
- Npc
- route
- routines
- toMachineId
Particles
Section titled “Particles”- EmitterProps
- ParticleBurst
- ParticleHandle
- ParticleSpawner
- ParticlesProps
- ParticleEffect
- Emitter
- Particles
- useParticles
Physics
Section titled “Physics”- BodyRefusal
- CombineRule
- JointRefusal
- JointType
- MoverRefusal
- PlatformOnLeave
- RigidBodyType
- ShapeType
- BoxShape
- CapsuleShape
- CastRayOptions
- CastShapeOptions
- ColliderOptions
- CollisionEntered
- CollisionExited
- CollisionLayerHandle
- CommitPoseOptions
- ConeShape
- ConvexHullShape
- CylinderShape
- DynamicBodyOptions
- FixedBodyOptions
- ForceOptions
- HeightfieldShape
- IsTouchingOptions
- JointChanges
- JointLimits
- JointMotor
- KinematicBodyOptions
- MaterialOptions
- MoveAlongNavMeshOptions
- MoveAndSlideOptions
- MoveAndSlideResult
- MoveCharacterOptions
- MoveCharacterResult
- MoverHit
- OverlapResult
- OverlapShapeOptions
- PhysicsOptions
- PoseChanges
- QueryFilterOptions
- RayHitResult
- ShapeHitResult
- SphereShape
- TeleportOptions
- TeleportResult
- TriangleMeshShape
- TriggerEntered
- TriggerExited
- VoxelsShape
- BodyChanges
- BodyDeclaration
- BodyEntity
- BodyOptions
- BodyTarget
- CharacterControllerOverrides
- ColliderChanges
- ColliderDeclaration
- ColliderShape
- CollisionMask
- DynamicColliderShape
- JointOptions
- JointProps
- KinematicColliderShape
- PhysicsSettings
- PhysicsValues
- PointHullShape
- QueryShape
- QuerySource
- VoxelCell
- AddedVelocityTrait
- BodyIgnoreTrait
- BodyTrait
- BodyVelocityTrait
- CharacterControllerTrait
- CharacterTrait
- ColliderTrait
- CollisionEnteredEvent
- CollisionExitedEvent
- CoreLayers
- FellOutOfWorldEvent
- JointBrokenEvent
- JointTrait
- TriggerEnteredEvent
- TriggerExitedEvent
- addLinearVelocity
- applyForce
- applyImpulse
- applyTorque
- applyTorqueImpulse
- box
- capsule
- castRay
- castRayAll
- castShape
- commitPose
- cone
- convexHull
- createJoint
- cylinder
- definePhysics
- findRapierWorld
- heightfield
- isSleeping
- isTouching
- Joint
- measureTurn
- moveAlongNavMesh
- moveAndSlide
- moveCharacter
- orderBasesFirst
- overlapShape
- readAngularVelocity
- readJointReaction
- readLinearVelocity
- readNextPose
- readTriggerOccupants
- setAngularVelocity
- setBody
- setCollider
- setGravity
- setJoint
- setLinearVelocity
- setNextPose
- setVoxel
- sleep
- sphere
- teleport
- triangleMesh
- turnTowards
- voxels
- wakeUp
Player
Section titled “Player”- GroundMark
- ModelClip
- MovementPreset
- RespawnPlace
- TeamColorMode
- WalkRefusal
- CharacterSpawnProps
- HeldItemProps
- NameplateOptions
- NameplateProps
- Push
- PushRead
- RespawnCharacterOptions
- RespawnOptions
- SpeedModifier
- VrmBody
- WalkRefused
- WalkRoute
- AimPoint
- ModelClipSpeeds
- NameplateAudience
- NameplateSetting
- NameplateWalls
- SpeedModifierKey
- WalkToResult
- AimPointTrait
- stopCommandDeclaration
- walkCommandDeclaration
- addSpeedModifier
- aimAt
- CharacterSpawn
- countDownSpeedModifiers
- defineSpeedModifier
- freeCharacter
- HeldItem
- isCharacterSpawnReady
- Nameplate
- pushCharacter
- readMoveSpeed
- readPush
- registerAvatar
- removeSpeedModifier
- respawnCharacter
Players
Section titled “Players”- ConnectionState
- ControlRefusal
- ControlVisibility
- LeaveReason
- ReleaseReason
- Role
- Simulation
- AddBotPlayerOptions
- AddControllerOptions
- ControlOptions
- ControlReleaseContext
- CoreTrait
- CorrectionSmoothing
- JoinStep
- KickOptions
- NamedReleaseHook
- PlayerJoinContext
- PlayerLeaveContext
- PoseTolerance
- SetPresenceOptions
- SpawnCharacterOptions
- WriteInputOptions
- ControlReleaseHook
- ControlResult
- PlayerEntity
- PlayerHook
- PlayerJoinHook
- PlayerLeaveHook
- ConnectionTrait
- ControlledTrait
- defaultCorrectionSmoothing
- defaultPoseTolerance
- PlayerTrait
- PresenceTrait
- RoomControllerTrait
- ViewTargetTrait
- addBotPlayer
- addController
- control
- findCharacter
- findCharacterPlayer
- findController
- findPendingController
- findPlayerByPresence
- isControllerHeld
- isPlayer
- kick
- readControlled
- readLocalPlayer
- readPendingControlled
- readPlayers
- releaseControl
- setPresence
- setViewTarget
- spawnCharacter
- tryControl
- writeInput
Plugins
Section titled “Plugins”- BindingKind
- InputKind
- Phase
- AbilitiesOptions
- AngleInputDeclaration
- AngleInputOptions
- AxisInputDeclaration
- AxisInputOptions
- AxisKeys
- BindingOptions
- ButtonInputDeclaration
- ButtonInputOptions
- CharacterHooks
- CharacterKeys
- CharacterRespawnContext
- CharacterSpawnContext
- Composition
- ControlsOptions
- InputContextDeclaration
- InputContextHandle
- InputContextOptions
- InputLayout
- InputLayoutEntry
- KeyBinding
- KeyBindings
- Omission
- PageActionDeclaration
- PageActionHandle
- PageActionOptions
- PlayerText
- Plugin
- PluginConfig
- PluginFactory
- PluginFactoryOptions
- PluginSystems
- SystemHandle
- TouchControl
- VectorInputDeclaration
- VectorInputOptions
- VectorKeys
- VectorValue
- CharacterInputDeclarations
- CharacterRespawnHook
- CharacterSpawnHook
- CoreSystemHandle
- EngineActionName
- InputContextDeclarations
- InputDeclarations
- InputHandle
- InputValue
- KeyCode
- OptionalSystemHandle
- PageActionDeclarations
- PhaseName
- PluginList
- PluginSetup
- ReplaceableHandle
- Requirement
- SystemHandles
- abilities
- angleSteps
- axisSteps
- behaviours
- characters
- controls
- cooldowns
- core
- engineActions
- inventory
- machines
- maximumInputButtons
- maximumInputBytes
- maximumInputChanges
- npcs
- resources
- rounds
- stats
- tracks
- vectorSteps
- weapons
- anchorIfPresent
- angleInput
- axisInput
- buttonInput
- composePlugins
- defineCharacterInputs
- definePlugin
- definePluginFactory
- dragAndDrop
- inputContext
- isSystemEnabled
- omit
- pageAction
- requirePlugin
- vector2Input
Post-processing
Section titled “Post-processing”- AmbientOcclusionProps
- BloomProps
- LiveGrading
- PostProcessingProps
- VignetteProps
- ToneMappingMode
- ToneMappingMode
- AmbientOcclusion
- Bloom
- PostProcessing
- useLookGrading
- Vignette
Rendering
Section titled “Rendering”Replication
Section titled “Replication”Resources
Section titled “Resources”- ResourceStart
- ResourceBarProps
- ResourceProps
- ResourceSettings
- ResourceValue
- FilledResourceSettings
- HealthResourceKey
- HealthSettings
- KeyedCost
- ReservationKey
- ResourceCost
- ResourceKey
- ResourceTrait
- SavedResources
- healthResource
- ReservationsTrait
- changeResource
- checkCost
- commitCost
- declareResource
- defineReservation
- defineResource
- findResourceTrait
- readResource
- readResourcesSave
- refundCost
- registerHealth
- reserveCost
- Resource
- ResourceBar
- restoreResources
- useResource
- RoundRefusal
- RoundState
- RoundProps
- RoundScreenProps
- RoundStatus
- RoundMachine
- RoundTrait
- failRound
- finishRound
- Round
- RoundScreen
- startRound
- useRound
- PlayerSaveStatus
- SaveDestination
- SaveLimit
- SaveScope
- SaveStatus
- EntityRestoreContext
- EntitySaveContext
- GameSaveOptions
- IncludedSave
- NoGameSaveState
- PackedSave
- PlayerSaveContext
- PluginSave
- SaveAccount
- SaveCodec
- SaveCodecConfig
- SavedEntityKeyOptions
- SaveEntry
- SaveLoaded
- SaveOwner
- SaveReadProblem
- SaveRecord
- SaveRefused
- SaveSchedulerState
- SaveSession
- SaveSessionOptions
- SaveSizeProblem
- SaveStatusState
- SetSavedEntityOptions
- WorldSaveContext
- GameStateSaveDeclaration
- IncludeSaveDeclaration
- RestoreContext
- SaveConfig
- SaveContext
- SaveDeclaration
- SaveLoad
- SaveRead
- SaveSchema
- SaveScopeName
- SaveSize
- SaveVersions
- persist
- PlayerSaveTrait
- bindSaveSession
- createSaveSession
- defineSave
- defineSaveCodec
- findSavedEntity
- findSaveSession
- isOlderReader
- releaseSavedEntity
- requestSave
- save
- setSavedEntity
- useSaveStatus
- versionsOf
Settings
Section titled “Settings”- CostLevel
- SettingKind
- SettingsTab
- ButtonSettingRow
- ChoiceSettingRow
- SettingCost
- SliderSettingRow
- ToggleSettingRow
- DefaultVolumes
- EngineSettingKey
- GameSettingRow
- useSettings
- HideSetting
- readCameraShakeScale
- SettingRow
Shader
Section titled “Shader”- HistoryDepth
- StateType
- Machine
- MachineArgs
- MachineFields
- MachineRead
- StateConfig
- StatesConfig
- TransitionConfig
- WaitConfig
- ContextValue
- MachineAction
- MachineContext
- MachineEvent
- MachineHistory
- MachineRecord
- StateTags
- TopStateName
- TransitionTarget
- WhenRule
- WhenTest
- MachinePausedTrait
- states
- useMachineState
- Stat
- StatBase
- StatModifier
- SavedStats
- StatField
- StatsProps
- maxHealthStat
- moveSpeedStat
- StatsTrait
- addStatModifier
- declareStats
- readStat
- readStatsSave
- registerStatField
- removeStatModifiers
- resolveStat
- restoreStats
- setStatBase
- Stats
- TeamChangeCause
- Instigator
- Team
- TeamChangedRecord
- TeamMembership
- TeamRule
- TeamChangedEvent
- findTeam
- isAlly
- isFriendlyFireEnabled
- isTeammate
- readInstigator
- readTeams
Text chat
Section titled “Text chat”- TextChatMessageKind
- TextChatRefusal
- TextChatReportRefusal
- TextChatReportStatus
- TextChatState
- SendTextChatBlockOptions
- SendTextChatMessageOptions
- SendTextChatReportOptions
- TextChannel
- TextChannelOptions
- TextChat
- TextChatMessage
- TextChatOptions
- TextChatSessionState
- AddTextChatMessageOptions
- TextChatDeliveryRule
- TextChatPart
- TextChatReportResult
- TextChatSendResult
- TextChatTextPart
- useTextChatSession
- addTextChatMessage
- defineTextChat
- sendTextChatBlock
- sendTextChatLevel
- sendTextChatMessage
- sendTextChatReport
- teamTextChannel
- textChannel
- ActionBarShape
- Anchor
- BarSize
- BillboardUnits
- ButtonVariant
- ModalVariant
- PanelVariant
- Slot
- ActionBarProps
- ActionCooldown
- ActionSlot
- BillboardProps
- DragEnd
- DraggableProps
- FloatedText
- FloatingTextProps
- FloatingTextWriter
- GuardedDropTargetProps
- IconProps
- JoystickProps
- MenuState
- ModalClassNames
- ModalProps
- OpenDropTargetProps
- SliderStyle
- TapProps
- WindowProps
- DropTargetProps
- IconName
- PanelProps
- SelectOption
- useMenu
- ActionBar
- Bar
- Billboard
- Button
- Counter
- Draggable
- DropTarget
- FloatingText
- Heading
- Icon
- Image
- Joystick
- Modal
- NumberField
- Panel
- Select
- Slider
- takeEscape
- Tap
- Text
- TextField
- Toggle
- useDragging
- useFloatingText
- WarmHud
- Window
Weapons
Section titled “Weapons”- GrassShader
- LightingProps
- TimeOfDayOptions
- TrackScatterProps
- WorldLighting
- WorldOptions
- TrackSurfaceProps
- WorldProps
- WorldUnlit
- findTimeOfDay
- frameShot
- frameView
- Lighting
- readMap
- readMapRevision
- readModelThumbnail
- registerMap
- registerMapProps
- registerMaps
- setTimeOfDay
- TrackScatter
- TrackSurface
- useWorldEntity
- World