orkid: Skill for Claude Code

Orkid VarMap Reference

When answering questions about VarMap in orkid, consult these files.

Key Files

Component	Location
VarMap Template	ork.core/inc/ork/kernel/varmap.inl
VarMap Impl	ork.core/src/kernel/varmap.cpp
svar128_t (variant)	ork.core/inc/ork/kernel/svariant.h
Python Bindings	ork.core/inc/ork/python/common_bindings/pyext_varmap.inl

Core Concept

VarMap is a std::map<std::string, svar128_t> — a dynamic key-value store where values are 128-byte stack-allocated variants. Used throughout orkid as a universal data container.

Python API

from orkengine.core import VarMap

vm = VarMap()

# Attribute access (most common)
vm.name = "hello"           # __setattr__ → setValueForKey
val = vm.name                # __getattr__ → valueForKey
"name" in vm                 # __contains__
len(vm)                      # __len__

# Dotted keys (for annotations)
setattr(vm, "editor.filebase", "<assetcache>")

# Dictionary-style
vm["key"]                    # __getitem__ (raises on missing)

# Utilities
vm.keys()                    # List of all keys
vm.clone()                   # Deep copy
vm.dumpToString()            # Formatted dump with types

Supported Value Types

Anything that fits in svar128_t (128 bytes):

• Primitives: bool, int, float, double, str
• Math: fvec2, fvec3, fvec4, fmtx3, fmtx4, fquat
• Pointers: std::shared_ptr<T> for any type
• Nested: VarMap (for hierarchical data)
• Other: CrcString, datablock_ptr_t, etc.

C++ API

auto vm = std::make_shared<varmap::VarMap>();

// Set/get
vm->setValueForKey("name", val);        // Set svar128_t value
vm->valueForKey("name");                // Get (returns nil if missing)
vm->typedValueForKey<float>("speed");   // Type-safe get (attempt_cast)
vm->hasKey("name");                     // Check existence

// Typed helpers
vm->set<float>("speed", 1.5f);
vm->makeValueForKey<std::string>("label", "hello");  // Construct in-place
vm->makeSharedForKey<MyClass>("obj", args...);        // Construct shared_ptr

// Number coercion
vm->tryKeyAsNumber("value");            // Float from float/double/int
vm->tryKeyAsInteger("count");           // Int from int/float/double

// Utility
vm->clone();                            // Deep copy
vm->mergeVars(other_vm);                // Merge other into this
vm->hash();                             // CRC64 hash
vm->dumpkeys();                         // Vector of all keys