🔆
Documentation
Downloads
Examples
Templates
Github
NPM
Contact
Getting Started
Culling crazy expectations
Setting up a Default Cube game
Learning Default Cube
I: Views & Scenes
General Idea
Views & Scenes
Quick Glossary
II: Camera
Default Cube vs Three.js Camera
Switching Cameras
Following Objects
III: Actions & UI
Key Inputs
Touch & Mouse Inputs
User Interface
User Interface Text
Camera-facing User Interface
IV: Game Objects
Building Scenes
V: Physics
Overview
Navmeshes
Hit-testing
Surfaces
VI: Audio
Howler vs Three.js Audio
Independent Audio
Channels
VII: Debugging
DummyDebugger
IX: AI
Overview
AI Nodes
AI Maps
AiWrapper & AI Behaviours
Pathfinding
VIII: Persistence
Saving Variables
Custom Properties List
action
aiNode
aiSpawn
animation
bottom
cacheMaterial
camera
fullscreen
fullscreenOffset
fullscreenPreserveRatio
gameObject
if
ifNot
label
labelFont
labelSize
labelAlign
labelColor
labelOutlineColor
left
material
navmap
right
navpath
rotateX / Y / Z
scroll
shader
shading
slideshow
slidesX
slidesY
surface
top
Mobile Platforms
Android
Android - Bundling Game Asseets
iOS
Controlling Animations
Animation Wrappers
Particles
Creating Particle Emitters
particleObject: Object3D
particleDensity: number
positionBase / rotationBase / scaleBase: [x, y, z] | number
positionJitter / rotationJitter / scaleJitter: [x, y, z] | number
spawnJitter: number
globalTransforms: boolean
onCreate: function ({ target })
onFrame: function ({ target, random, lifeTime })
onReset: function ({ target })
UI Alignment
Aligning Elements on the Screen
AiService
getAiNodeById ()
AnimationService
registerAnimation ()
AnimationOverrideType
AssetsService
getDefaultCube ()
getAmbientLight ()
getTexture ()
getTextureSync ()
getHDRI ()
getReflectionsTexture ()
getModel ()
preloadModel ()
preloadFont ()
preloadAudio ()
getAudio ()
getMaterial ()
saveMaterial ()
cloneMaterial ()
cloneTexture ()
isDisposed ()
willBeDisposed ()
AudioService
AudioChannelEnums
playAudio ()
stopAudio ()
setMasterVolume ()
getMasterVolume ()
setAudioVolume ()
setAudioPlaybackRate ()
setChannelVolume ()
setChannelPlaybackRate ()
stopChannel ()
CameraService
getCamera ()
useCamera ()
follow ()
getFollowPivot ()
stopFollowing ()
getCameraAsTexture ()
preventOcclusion ()
allowOcclusion ()
lockTranslation ()
lockRotation ()
unlockTranslation ()
unlockRotation ()
DummyDebug
DebugFlags
on ()
off ()
GameInfoService
system ()
camera ()
vr (enabled = true)
vars ()
labels ()
animation ()
font ()
texture ()
model ()
audio ()
shader ()
custom ()
InputService
key ()
InteractionsService
InteractionEnums
registerListener ()
registerInvisibleListener ()
MathService
getVec2 ()
releaseVec2 ()
getQuaternion ()
releaseQuaternion ()
getVec3 ()
cloneVec3 ()
releaseVec3 ()
ParticleService
registerParticleEmitter ()
PhysicsService
enableNavmap ()
disableNavmap ()
registerSurfaceHandler ()
updatePathfinder ()
RenderService
getScene ()
getNativeCamera ()
getRenderer ()
pauseRendering ()
resumeRendering ()
SceneService
parseScene ()
setBackgroundImage ()
setBackground ()
getBackground ()
setEnvironment ()
getEnvironment ()
StorageService
set ()
get ()
SystemService
init ()
lockOrientation ()
onReady ()
TimeService
registerFrameListener ()
registerPersistentFrameListener ()
registerIntervalListener ()
UiService
registerUiElement ()
isUiElement ()
UtilsService
getRaycaster ()
releaseRaycaster ()
getBox3 ()
releaseBox3 ()
getCamera ()
releaseCamera ()
getEmpty ()
releaseEmpty ()
getBlankMaterial ()
releaseBlankMaterial ()
VarService
setVar ()
getVar ()
removeVar ()
registerPersistentVar ()
resolveVar ()
AiWrapper
registerBehaviour ()
getAiBehaviour ()
hasTargetNode ()
setTargetNode ()
getTargetNode ()
getDistanceToTargetNode ()
getGroundAngleToTargetNode ()
findPathToTargetNode ()
getPathLength ()
AnimationWrapper
playAnimation ()
stopAnimation ()
blendInAnimation ()
playAllAnimations ()
stopAllAnimations ()
PhysicsWrapper
enableNavmaps ()
getSimpleVelocity ()
setSimpleVelocity ()
enableNoClip ()
disableNoClip ()
Preloader
Overview
constructor
Built-in Utils
Math 𝛑 Helpers
removePlaceholder ()
replacePlaceholder ()
cloneValue ()
getRandomColor ()
getRandomElement ()
spliceRandomElement ()
moduloAngle ()
defaultTo ()
swapVectors ()
Contact
Downloads
Example: Chess
Examples
Templates
TODO
[AssetsService] Rename getImage to getTexture
[General] Uniform axes
[AiService] Geometry AI nodes
[AudioService] AudioMapping
[Utils] Replacement should inherit original transforms
[RenderService] Add pre-compile helper
[AssetsService] Improve raycasting by using BVH
[SceneService] setBackgroundImage and setBackground naming
⇠ Documentation
InputService
⌘
key ()
key(keyName)
Returns key state. See
MDN KeyboardEvent.key
.