Function Script_Get

engine/gameobject/src/gameobject/gameobject_script.cpp:620–692

gets a named property of the specified game object or component * * @name go.get * @param url [type:string|hash|url] url of the game object or component having the property * @param property [type:string|hash] id of the property to retrieve * @param [options] [type:table] optional options table * - index [type:number] index into array property (1 based) * - key [

     * go.get("#my_component", "some_property", { keys = { "root", "child_node" } })
     */
    int Script_Get(lua_State* L)
    {
        ScriptInstance* i = ScriptInstance_Check(L);
        Instance* instance = i->m_Instance;
        dmMessage::URL sender;
        dmScript::GetURL(L, &sender);
        dmMessage::URL target;
        dmScript::ResolveURL(L, 1, &target, &sender);
        DM_HASH_REVERSE_MEM(hash_ctx, 256);
        if (target.m_Socket != dmGameObject::GetMessageSocket(i->m_Instance->m_Collection->m_HCollection))
        {
            return luaL_error(L, "go.get can only access instances within the same collection.");
        }
        dmhash_t property_id = 0;
        if (lua_isstring(L, 2))
        {
            property_id = dmHashString64(lua_tostring(L, 2));
        }
        else
        {
            property_id = dmScript::CheckHash(L, 2);
        }
        dmGameObject::HInstance target_instance = dmGameObject::GetInstanceFromIdentifier(dmGameObject::GetCollection(instance), target.m_Path);
        if (target_instance == 0)
        {
            return luaL_error(L, "Could not find any instance with id '%s'.", dmHashReverseSafe64Alloc(&hash_ctx, target.m_Path));
        }

        LuaToPropertyOptionsResult options_result = {};

        // Options table
        if (lua_gettop(L) > 2)
        {
            dmGameObject::LuaToPropertyOptions(L, 3, &options_result);
        }

        dmGameObject::PropertyDesc property_desc;
        dmGameObject::PropertyResult result = dmGameObject::GetProperty(target_instance, target.m_Fragment, property_id, options_result.m_Options, property_desc);
        if (result == dmGameObject::PROPERTY_RESULT_OK && !options_result.m_IndexRequested && property_desc.m_ValueType == dmGameObject::PROP_VALUE_ARRAY && property_desc.m_ArrayLength > 1)
        {
            lua_newtable(L);

            dmGameObject::PropertyOptions get_arrayed_property_opts;
            dmGameObject::AddPropertyOptionsIndex(&get_arrayed_property_opts, 0);

            // We already have the first value, so no need to get it again.
            // But we do need to check the result, we could still get errors even if the result is OK
            int handle_go_get_result = CheckGetPropertyResult(L, "go", result, property_desc, property_id, target, get_arrayed_property_opts, options_result.m_IndexRequested, options_result.m_KeysRequested);
            if (handle_go_get_result != 1)
            {
                return handle_go_get_result;
            }
            lua_rawseti(L, -2, 1);

            // Get the rest of the array elements and check each result individually
            for (int i = 1; i < property_desc.m_ArrayLength; ++i)
            {
                SetPropertyOptionsByIndex(&get_arrayed_property_opts, 0, i);