Function Script_Delete

engine/gameobject/src/gameobject/gameobject_script.cpp:1912–1980

delete one or more game object instances * Delete one or more game objects identified by id. Deletion is asynchronous meaning that * the game object(s) are scheduled for deletion which will happen at the end of the current * frame. Note that game objects scheduled for deletion will be counted against * `max_instances` in "game.project" until they are actually removed. *

     *
     */
    static int Script_Delete(lua_State* L)
    {
        int args = lua_gettop(L);

        if(args > 2)
        {
            return luaL_error(L, "go.delete invoked with too many argumengs");
        }

        // deduct recursive bool parameter (optional last parameter)
        bool recursive = false;
        if(args != 0)
        {
            if(lua_isboolean(L, 1))
            {
                // if argument #1 is boolean, no more arguments are accepted
                if(args > 1)
                {
                    return luaL_error(L, "go.delete expected one argument when argument #1 is boolean type");
                }
                recursive = lua_toboolean(L, 1);
                lua_pop(L, 1);
                --args;
            }
            else if(args > 1)
            {
                // if argument #1 isn't a boolean, it's resolved later. Argument #2 is required to be a boolean
                if(lua_isboolean(L, 2))
                {
                    recursive = lua_toboolean(L, 2);
                }
                else
                {
                    return luaL_error(L, "go.delete expected boolean as argument #2");
                }
                lua_pop(L, 1);
                --args;
            }
        }

        // handle optional parameter #1 is table or nil
        if(args != 0)
        {
            if(lua_istable(L, 1))
            {
                int result = DeleteGOTable(L, recursive);
                if(result == 0)
                {
                    assert(args == lua_gettop(L));
                }
                return result;
            }
            else if(lua_isnil(L, 1))
            {
                return luaL_error(L, "go.delete() invoked with first argument 'id' set to 'nil'");
            }
        }