Skip to content

Lua Docs for World to Build

Event

Initializing search

Home
Classes
Events
Global
Macros

Lua Docs for World to Build

Home
Classes
Classes
- Home - Classes
- (Block) Renderer
  (Block) Renderer
  - (Block) Renderer
  - Remove
  - color
  - name
  - owner
  - shadows
  - transparency
  - visible
- (Voxel) Renderer
  (Voxel) Renderer
  - (Voxel) Renderer
  - Remove
  - design
  - name
  - owner
  - shadows
  - tint
  - transparency
  - visible
- Character
  Character
  - Character
  - Damage
  - DropAllItems
  - DropEquippedItem
  - DropItem
  - GrantItem
  - HasItem
  - HasItemEquipped
  - Heal
  - Impulse
  - Jump
  - Kill
  - LootItem
  - RemoveAllItems
  - RemoveEquippedItem
  - RemoveItem
  - SetNoClipMovement
  - SetNormalMovement
  - Unground
  - alive
  - alwaysHideNametag
  - backDirection
  - cameraDirection
  - cameraPosition
  - cameraZoom
  - canSeeNametag
  - dead
  - downDirection
  - forceField
  - forwardDirection
  - frozen
  - god
  - gravityDirection
  - gravityMultiplier
  - gravityPower
  - health
  - invulnerable
  - isFirstPerson
  - isHost
  - isLocal
  - jumps
  - leftDirection
  - lockCameraMovement
  - lockCameraZoom
  - lockMovement
  - mass
  - maxHealth
  - maxShields
  - movementMode
  - nametagVisible
  - netId
  - nickname
  - player
  - position
  - rightDirection
  - rotation
  - scale
  - screenPosition
  - shields
  - speed
  - upDirection
  - username
  - visible
- Collider
  Collider
  - Collider
  - Remove
  - bounciness
  - enabled
  - isTrigger
  - name
  - owner
  - shape
  - slipperiness
- Color
  Color
  - Color
  - ColorFromHex
  - Greyscale
  - HexFromColor
  - Lerp
  - New
  - ToGreyscale
  - black
  - blue
  - cyan
  - green
  - grey
  - magenta
  - red
  - white
  - yellow
- Component
  Component
  - Component
  - Remove
  - name
  - owner
- Event
  Event
  - Event Event
    Table of contents
    
    Description
  - Bind
  - BindFunction
  - Broadcast
  - BroadcastToAllPlayers
  - BroadcastToPlayer
  - BroadcastToServer
  - Unbind
  - UnbindFunction
- HitData
  HitData
  - HitData
  - direction
  - end
  - endPosition
  - hitDirection
  - hitDistance
  - hitPosition
  - hitWildcard
  - length
  - start
  - startPosition
- Input
  Input
- Interactable
  Interactable
  - Interactable
  - Remove
  - cooldown
  - enabled
  - hideDot
  - holdDuration
  - name
  - owner
  - visible
- Item
  Item
  - Item
  - Remove
  - canDrop
  - displayName
  - dropOnDeath
  - name
  - owner
  - touchToLoot
- Light
  Light
  - Light
  - Remove
  - brightness
  - color
  - enabled
  - name
  - owner
  - range
  - shadows
  - spotlightAngle
  - type
- Math
  Math
  - Math
  - Clamp
  - Lerp
  - LerpUnclamped
  - MapRange
  - Max
  - Min
  - Round
  - RoundDown
  - RoundUp
- Object
  Object
  - Object
  - AddComponent
  - AddScript
  - Delete
  - Duplicate
  - GetAllChildren
  - GetAllScripts
  - GetChildByName
  - GetChildrenByName
  - GetComponent
  - GetDirectChildren
  - GetScriptByName
  - MoveTo
  - NetMessageAll
  - NetMessagePlayer
  - RemoveAllScripts
  - RemoveComponent
  - RemoveScript
  - RemoveScriptByName
  - RotateAround
  - RotateTowards
  - SetParent
  - Unparent
  - backDirection
  - blockRenderer
  - collider
  - downDirection
  - forwardDirection
  - id
  - interactable
  - item
  - leftDirection
  - light
  - localTable
  - name
  - netId
  - netTable
  - parent
  - physics
  - position
  - renderer
  - replicated
  - respawn
  - rightDirection
  - root
  - rotation
  - screenPosition
  - size
  - sound
  - upDirection
  - voxelRenderer
  - worldText
- Physics
  Physics
  - Physics
  - AddExplosionForce
  - AddForce
  - AddTorque
  - Remove
  - angularVelocity
  - autoMass
  - enabled
  - gravity
  - mass
  - name
  - owner
  - velocity
- Player
  Player
  - Player
  - ClearCheckpoint
  - Respawn
  - RespawnAt
  - RespawnHere
  - SendSystemChat
  - SetCheckpoint
  - character
  - checkpoint
  - hasAliveCharacter
  - hasCheckpoint
  - id
  - isHost
  - isLocal
  - netId
  - nickname
  - username
- Random
  Random
  - Random
  - AliveCharacter
  - Character
  - Color
  - ColorAndAlpha
  - InCircle
  - InSphere
  - Noise
  - Number
  - NumberRounded
  - OnCircle
  - OnSphere
  - Player
  - PlayerWithAliveCharacter
- Rect
  Rect
  - Rect
  - Contains
  - New
  - Overlaps
- Respawn
  Respawn
  - Respawn
  - Remove
  - enabled
  - name
  - owner
  - type
- Script
  Script
  - Script
  - Remove
  - Run
  - RunOnAllClients
  - RunOnClient
  - RunOnServer
  - name
  - owner
  - scriptName
- Sound
  Sound
  - Sound
  - Pause
  - PauseLocal
  - Play
  - PlayLocal
  - Remove
  - SetTime
  - SetTimeLocal
  - Stop
  - StopLocal
  - autoplay
  - global
  - id
  - looped
  - name
  - owner
  - pitch
  - radius
  - volume
- Table
  Table
  - Table
  - New
- Time
  Time
  - Time
  - day
  - deltaTime
  - hour
  - millisecond
  - minute
  - month
  - physicsDeltaTime
  - second
  - time
  - year
- Vector2
  Vector2
  - Vector2
  - Angle
  - ClampMagnitude
  - Distance
  - Dot
  - Lerp
  - Middle
  - New
  - Normalize
  - Perpendicular
  - Reflect
  - SignedAngle
- Vector3
  Vector3
  - Vector3
  - Angle
  - ClampMagnitude
  - Cross
  - Direction
  - Distance
  - Dot
  - Lerp
  - LookRotation
  - Middle
  - New
  - Normalize
  - Reflect
  - SignedAngle
  - Slerp
- World
  World
  - World
  - id
  - name
  - ownerId
  - roomSize
  - visits
- WorldSettings
  WorldSettings
- WorldText
  WorldText
  - WorldText
  - Remove
  - alignment
  - color
  - enabled
  - faceCamera
  - font
  - hiddenDistance
  - hideAtDistance
  - name
  - outlineColor
  - outlineWidth
  - owner
  - size
  - text
Events
Events
Global
Global
- Home - Global Functions
- Clamp
- GetScreenHeight
- GetScreenSize
- GetScreenWidth
- LineCast
- Magnitude
- MapRange
- NetMessageGlobalAll
- NetMessageGlobalPlayer
- Normalized
- PlayOneShot
- PlayOneShotAt
- PlayOneShotFor
- PlayOneShotForAt
- PlayOneShotLocal
- PlayOneShotLocalAt
- RayCast
- ScreenPosition
- SendSystemChatToAll
- SphereCast
- Characters
  Characters
- Items
  Items
  - GrantItemTo
  - LootItemTo
- Objects
  Objects
- Players
  Players
- Validity
  Validity
  - IsBlockRenderer
  - IsCharacter
  - IsCollider
  - IsComponent
  - IsInteractable
  - IsItem
  - IsLight
  - IsObject
  - IsPhysics
  - IsPlayer
  - IsRenderer
  - IsRespawn
  - IsScript
  - IsSound
  - IsValid
  - IsVoxelRenderer
  - IsWorldText
Macros
Macros
- Macros
- branch
- delay
- hostPlayer
- isClient
- isHost
- isServer
- localPlayer
- object
- print
- printScreen
- spawn
- this
- timer
- wait
- waitPhysicsTick
- waitTick

Table of contents

Description

Event

Description

A library of functions to interact with the event system.

Previous owner

Next Bind

Made with Material for MkDocs