API

Free functions

Global

• assert
• include
• print
• pprint
• tostring
• AssertMetatable
• GetMetatable
• RegisterClientAssets
• RegisterClientScript
• RegisterMetatable

assets

• assets.GetTexture

match

• match.BroadcastChatMessage
• match.BroadcastPacket
• match.CreateEntity
• match.CreateWeapon
• match.GetCamera
• match.GetEntitiesByClass
• match.GetEntityByUniqueId
• match.GetGamemode
• match.GetLayerCount
• match.GetLocalTick
• match.GetMilliseconds
• match.GetPlayerByIndex
• match.GetPlayers
• match.GetSeconds
• match.GetTick
• match.GetTickDuration
• match.ResetTerrain

packet

• packet.NewPacket
• packet.SetHandler

particle

• particle.CreateGroup

physics

• physics.CreateDampenedSpringConstraint
• physics.CreatePinConstraint
• physics.CreatePivotConstraint
• physics.CreateRotaryLimitConstraint
• physics.RegionQuery
• physics.Trace
• physics.TraceMultiple

render

• render.GetFrameTime

scripts

• scripts.ReloadAll

sound

• sound.CreateMusicFromFile

timer

• timer.Create
• timer.Sleep

Classes

Camera

• Camera:GetFOV
• Camera:GetPosition
• Camera:GetZoomFactor
• Camera:GetViewport
• Camera:MoveBy
• Camera:MoveToPosition
• Camera:SetFOV
• Camera:SetZoomFactor
• Camera:Project
• Camera:Unproject

Constraint

• Constraint:EnableBodyCollision

• Constraint:GetErrorBias

• Constraint:GetLastForce

• Constraint:GetLastImpulse

• Constraint:GetMaxForce

• Constraint:IsBodyCollisionEnabled

• Constraint:Remove

• Constraint:SetErrorBias

• Constraint:SetMaxForce

  Inherited by:

  • PivotConstraint

  • PinConstraint

    • PinConstraint:GetDistance
    • PinConstraint:SetDistance

  • RotaryLimitConstraint

    • RotaryLimitConstraint:GetMaxAngle
    • RotaryLimitConstraint:GetMinAngle
    • RotaryLimitConstraint:SetMaxAngle
    • RotaryLimitConstraint:SetMinAngle

  • SpringConstraint

IncomingNetworkPacket

• IncomingNetworkPacket:ReadBoolean
• IncomingNetworkPacket:ReadColor
• IncomingNetworkPacket:ReadCompressedInteger
• IncomingNetworkPacket:ReadCompressedUnsigned
• IncomingNetworkPacket:ReadDouble
• IncomingNetworkPacket:ReadEntity
• IncomingNetworkPacket:ReadSingle
• IncomingNetworkPacket:ReadString
• IncomingNetworkPacket:ReadVector2

InputController

Inherited by:

• DummyInputController

Music

• Music:EnableLooping
• Music:GetDuration
• Music:GetPlayingOffset
• Music:GetSampleCount
• Music:GetSampleRate
• Music:IsLooping
• Music:IsPlaying
• Music:Pause
• Music:Play
• Music:SetPlayingOffset
• Music:Stop

OutgoingNetworkPacket

• OutgoingNetworkPacket:WriteBoolean
• OutgoingNetworkPacket:WriteColor
• OutgoingNetworkPacket:WriteCompressedInteger
• OutgoingNetworkPacket:WriteCompressedUnsigned
• OutgoingNetworkPacket:WriteDouble
• OutgoingNetworkPacket:WriteEntity
• OutgoingNetworkPacket:WriteSingle
• OutgoingNetworkPacket:WriteString
• OutgoingNetworkPacket:WriteVector2

PlayerMovementController

Inherited by:

• BasicPlayerMovementController

• NoclipPlayerMovementController

ParticleGroup

• ParticleGroup:AddController
• ParticleGroup:AddGenerator
• ParticleGroup:GenerateParticles
• ParticleGroup:GetParticleCount
• ParticleGroup:Kill
• ParticleGroup:SetRenderer

Player

• Player:GetControlledEntity
• Player:GetLayerIndex
• Player:GetPlayerIndex
• Player:GetName
• Player:GetPing
• Player:IsAdmin
• Player:MoveToLayer
• Player:PrintChatMessage
• Player:SendPacket
• Player:SetAdmin
• Player:UpdateControlledEntity
• Player:UpdateLayerVisiblity

RandomEngine

• RandomEngine:Generate
• RandomEngine:Seed

Scoreboard

• Scoreboard:AddColumn
• Scoreboard:AddTeam
• Scoreboard:RegisterPlayer
• Scoreboard:UnregisterPlayer
• Scoreboard:UpdatePlayerTeam
• Scoreboard:UpdatePlayerValue

Sound

• Sound:Stop

Sprite

• Sprite:GetOrigin
• Sprite:GetSize
• Sprite:Hide
• Sprite:IsValid
• Sprite:IsVisible
• Sprite:SetColor
• Sprite:SetCornerColor
• Sprite:SetCornerColors
• Sprite:SetOffset
• Sprite:SetRotation
• Sprite:SetSize
• Sprite:Show

Texture

• Texture:GetSize

Tilemap

• Tilemap:GetMapSize
• Tilemap:GetSize
• Tilemap:GetTileSize
• Tilemap:Hide
• Tilemap:IsValid
• Tilemap:IsVisible
• Tilemap:SetOffset
• Tilemap:SetRotation
• Tilemap:SetTileColor
• Tilemap:Show

Scripted entities

Element

• Element:AddModel

• Element:AddSprite

• Element:DealDamage

• Element:DeleteOnRemove

• Element:DumpCreationInfo

• Element:Disable

• Element:Enable

• Element:GetDirection

• Element:GetLayerIndex

• Element:GetOwner

• Element:GetProperty

• Element:GetPosition

• Element:GetRotation

• Element:GetScale

• Element:IsEnabled

• Element:IsLookingRight

• Element:IsValid

• Element:Kill

• Element:On

• Element:OnAsync

• Element:PlaySound

• Element:SetLifeTime

• Element:SetParent

• Element:SetScale

• Element:ToLocalPosition

• Element:ToGlobalPosition

• Element:Trigger

  Inherited by:

  • Entity

    • Entity:AddLayer
    • Entity:AddTilemap
    • Entity:ApplyImpulse
    • Entity:ClearLayers
    • Entity:Damage
    • Entity:ForceSleep
    • Entity:GetColliders
    • Entity:GetHealth
    • Entity:GetMass
    • Entity:GetMomentOfInertia
    • Entity:GetPlayerMovementController
    • Entity:GetPlayerMovementSpeed
    • Entity:GetPlayerJumpHeight
    • Entity:GetUpVector
    • Entity:GetVelocity
    • Entity:GetWeaponCount
    • Entity:GiveWeapon
    • Entity:HasWeapon
    • Entity:Heal
    • Entity:InitWeaponWielder
    • Entity:IsFullHealth
    • Entity:InitRigidBody
    • Entity:IsPlayerOnGround
    • Entity:IsSleeping
    • Entity:OverrideMovementController
    • Entity:Remove
    • Entity:RemoveWeapon
    • Entity:SelectWeapon
    • Entity:SetAngularVelocity
    • Entity:SetColliders
    • Entity:SetDirection
    • Entity:SetMass
    • Entity:SetMomentOfInertia
    • Entity:SetPosition
    • Entity:SetRotation
    • Entity:SetVelocity
    • Entity:UpdateInputs
    • Entity:UpdatePlayerMovementController
    • Entity:UpdatePlayerMovementSpeed
    • Entity:UpdatePlayerJumpHeight

  • Weapon

    • Weapon:GetOwnerEntity
    • Weapon:IsPlayingAnimation
    • Weapon:PlayAnim
    • Weapon:SetNextTriggerTime
    • Weapon:Shoot