Documentation › API Reference › Object › Entity

GetKeyValue

This function gets an entity key value. A key value is a string value associated with a key name.

Syntax

Returns

Returns the entity key value for the specified key, if it exists. Otherwise the specified default value is returned.

Example

--Create a window
window = Window:Create()
context = Context:Create(window)
world = World:Create()

local camera = Camera:Create()
camera:SetRotation(35,0,0)
camera:Move(0,0,-5)

local light = DirectionalLight:Create()
light:SetRotation(35,35,0)

--Create a model
model = Model:Box()
model:SetKeyValue("name","Box1")
model:SetColor(0.0,0.0,1.0)

while true do
        if window:Closed() or window:KeyHit(Key.Escape) then return false end
        
        Time:Update()
        world:Update()
        world:Render()
        
        model:Turn(0,Time:GetSpeed(),0)
        
        context:SetBlendMode(Blend.Alpha)
        context:DrawText("Name: "..model:GetKeyValue("name"), 2, 2)
        context:SetBlendMode(Blend.Solid)
        
        context:Sync()
end