Skip to content

KeyValues

Fields

This class has no fields.


Functions

new

Name Type Description
name string -

Return value

Name Type Description
kv KeyValues* New instance of KeyValues
local kv = KeyValues.new("test")

LoadFromBuffer

Name Type Description
name string Name of resource
buffer string Content

Return value

Name Type Description
kv KeyValues* New instance of KeyValues
local kv = KeyValues.LoadFromBuffer("test", [[
  "VertexLitGeneric"
  {
    "$basetexture" "nature/urban_puddle01a_ssbump"
    "$additive" "1"
    "$selfillum" "1"
    "$nocull" "1"
    "$wireframe" "1"
    "Proxies"
    {
      "TextureScroll"
      {
   "texturescrollvar" "$BasetextureTransform"
   "texturescrollrate" "0.5"
   "texturescrollangle" "90"
      }
    }
  }
]])

FindKey

Name Type Description
name string -
create bool -

Return value

Name Type Description
kv KeyValues* Found or created key
local kv = KeyValues.new("test")
local key = kv:FindKey("key1", 0)

SetInt

Name Type Description
name string Key name
value int New value
local kv = KeyValues.new("test")
kv:SetInt("key1", 0)

SetBool

Name Type Description
name string Key name
value bool New value
local kv = KeyValues.new("test")
kv:SetBool("key1", true)

SetColor

Name Type Description
name string Key name
value Color New value
local kv = KeyValues.new("test")
kv:SetColor("key1", Color.new())

SetFloat

Name Type Description
name string Key name
value float New value
local kv = KeyValues.new("test")
kv:SetFloat("key1", 1.0)

SetUint64

Name Type Description
name string Key name
value unsigned int New value
local kv = KeyValues.new("test")
kv:SetUint64("key1", 0)

SetString

Name Type Description
name string Key name
value string New value
local kv = KeyValues.new("test")
kv:SetString("key1", "value")

GetInt

Name Type Description
name string Key name
def int Default value

Return value

Name Type Description
value int Value of a key
local kv = KeyValues.new("test")
kv:SetInt("key1", 1)
print(kv:GetInt("key1", 0))

GetBool

Name Type Description
name string Key name
def bool Default value

Return value

Name Type Description
value bool Value of a key
local kv = KeyValues.new("test")
kv:SetBool("key1", true)
print(kv:GetBool("key1", false))

GetBool

Name Type Description
name string Key name
def Color Default value

Return value

Name Type Description
value Color Value of a key
local kv = KeyValues.new("test")
kv:SetColor("key1", Color.new())
local clr = kv:GetColor("key1", Color.new(1.0, 1.0, 1.0))

GetFloat

Name Type Description
name string Key name
def float Default value

Return value

Name Type Description
value float Value of a key
local kv = KeyValues.new("test")
kv:SetFloat("key1", 1.0)
print(kv:GetFloat("key1", 0.0))

GetUint64

Name Type Description
name string Key name
def unsinged int Default value

Return value

Name Type Description
value unsigned int Value of a key
local kv = KeyValues.new("test")
kv:SetUint64("key1", 1)
print(kv:GetUint64("key1", 0))

GetString

Name Type Description
name string Key name
def string Default value

Return value

Name Type Description
value string Value of a key
local kv = KeyValues.new("test")
kv:SetString("key1", "value1")
print(kv:GetString("key1", ""))