GetKeyValue() & SetKeyValue() in lua

[SpiderPig]

What's the correct way to handle GetKeyValue() & SetKeyValue() in Lua now, so I can make custom keys?

[Josh]

Do you mean in the editor?

[SpiderPig]

I mean in a script attached to the entity, so when I call SetKeyValue() from C++ I can perform Lua code on that entity.

[Rick]

local value = entity:GetKeyValue("key")

 

entity:SetKeyValue("key", "value")

 

Is that all you mean?

[SpiderPig]

I want to handle the event like in LE2;

 

function object:SetKey(key,value)
if key=="key1" then
self.key1=tonumber(value)
else
return self.super:SetKey(key,value)
end
return 1

end

 

...or does LE3 handle it in a different way?

[Rick]

Yeah, it's different. There is no function that gets called when you set values from the editor.

 

Check out http://www.leadwerks.com/werkspace/page/documentation/_/user-guide/object-scripts-r631

[SpiderPig]

Thanks for that. So SetKeyValue() can only set keys that have been predefined then, like an entity's name or something...

[Rick]

No, you can set anything you want (has to be text I think though).

 

entity:SetKeyValue("age", "10")

 

entity:SetKeyValue("eye.color", "blue")

 

etc

[SpiderPig]

I'll give that a go, Thanks

[Josh]

Probably best to use Entity::SetString and GetString(). This will attach values to the Lua script object, if a script is present. They GetKey/SetKey functionality was just left in for backwards compatibility.

[SpiderPig]

Can SetString() be handled in the script so when a value changes I can execute some code? ...rather than checking for the changed value in UpdateWorld() - like LE2 handled SetKey()...

[Josh]

No, but you could just call Entity::CallFunction(functionname)

[SpiderPig]

That'd be the shot, thanks. Is there any documentation for CallFunction, SetString & GetString? I looked under "Entity" but found only SetString with not much info...