Slitherine

quote:

but ONLY if the code triggered by the event does not attempt to delete the event that triggered the code in the first place.

quote:

but I would really rather find a way to delete the events after they are executed.

CleanupEvent = 
function( eventName )		
    local e,p = pcall(ScenEdit_GetEvent,eventName);
    if(e == true and p ~=nil)  then
		--remove all the actions connected to this event!
		for k,v in pairs(p.actions) do
            local aName = ''
            if (v.LuaScript ~= nil) then aName = v.LuaScript.Description 
            elseif (v.ChangeMissionStatus ~= nil) then aName = v.ChangeMissionStatus.Description 
            elseif (v.NewStatus ~= nil) then aName = v.NewStatus.Description 
            elseif (v.EndScenario ~= nil) then aName = v.EndScenario.Description 
            elseif (v.Message ~= nil) then aName = v.Message.Description 
            elseif (v.Text ~= nil) then aName = v.Text.Description 
            elseif (v.Points ~= nil) then aName = v.Points.Description 
            elseif (v.SideID ~= nil) then aName = v.SideID.Description 
            elseif (v.TeleportInArea ~= nil) then aName = v.TeleportInArea.Description 
            else aName = nil end
            if (aName ~= nil) then

				--print('disconnecting action: '..aName..'from event: '..eventName)
                ScenEdit_SetEventAction(eventName,{mode='remove',name=aName})
				--print('destroying action: '..aName)
                ScenEdit_SetAction({mode='remove',name=aName})
            end
		end
        
		--remove all the triggers connected to this event!
		for k,v in pairs(p.triggers) do
            local tName = ''
            if (v.Points ~= nil) then tName = v.Points.Description 
            elseif (v.RandomTime) then tName = v.RandomTime.Description 
            elseif (v.RegularTime) then tName = v.RegularTime.Description 
            elseif (v.ScenEnded) then tName = v.ScenEnded.Description 
            elseif (v.ScenLoaded) then tName = v.ScenLoaded.Description 
            elseif (v.Time) then tName = v.Time.Description 
            elseif (v.UnitDamaged) then tName = v.UnitDamaged.Description 
            elseif (v.UnitDestroyed) then tName = v.UnitDestroyed.Description 
            elseif (v.UnitDetected) then tName = v.UnitDetected.Description 
            elseif (v.UnitEmissions) then tName = v.UnitEmissions.Description 
            elseif (v.UnitEntersArea) then tName = v.UnitEntersArea.Description 
            elseif (v.UnitRemainsInArea) then tName = v.UnitRemainsInArea.Description 
            elseif (v.UnitBaseStatus) then tName = v.UnitBaseStatus.Description 
            elseif (v.UnitCargoMoved) then tName = v.UnitCargoMoved.Description 
            else tName = nil end
            if (tName ~= nil) then

				--print('disconnecting tigger: '..tName..'from event: '..eventName)
                ScenEdit_SetEventTrigger(eventName,{mode='remove',name=tName})
				--print('destroying tiggger: '..tName)
                ScenEdit_SetTrigger({mode='remove',name=tName})
            end
		end
	
		--remove all the conditions connected to this event!
		for k,v in pairs(p.conditions) do
            local cName = ''
            if (v.LuaScript~= nil) then cName = v.LuaScript.Description
            elseif (v.ScenHasStarted) then cName = v.ScenHasStarted.Description
            elseif (v.SidePosture) then cName = v.SidePosture.Description
			else cName = nil end
            if (cName ~= nil) then
				--print('disconnecting condition: '..cName..'from event: '..eventName)
                ScenEdit_SetEventCondition(eventName,{mode='remove',name=cName})
				--print('destroying condition: '..cName)
                ScenEdit_SetCondition({mode='remove',name=cName})
            end
		end

		--remove the event
		ScenEdit_SetEvent(eventName, {mode='remove'})
	end
end

RemoveEvent = 
function(eventName)
    local event = ScenEdit_GetEvent(eventName)
    ScenEdit_SetEvent(event.guid, {mode = 'remove'})
end

LeMay.Event.RemoveEventAndTCAs = 
function(eventName)
    local event = ScenEdit_GetEvent(eventName)
    local eventTriggers = event.triggers
    local eventConditions = event.conditions
    local eventActions = event.actions

    ScenEdit_SetEvent(event.guid, {mode = 'remove'})

    --The first loop gets all the TCAs, the second loop gets the TCA details which is where the id is.
    for k, v in pairs(eventTriggers) do
        for key, value in pairs(v) do
            if type(value) == "table" then 
                local id = value.ID
                ScenEdit_SetTrigger({description = id, mode = 'remove'})
            end
        end
    end

    for k, v in pairs(eventConditions) do
        for key, value in pairs(v) do
            if type(value) == "table" then
                local id = value.ID
                ScenEdit_SetCondition({description = id, mode = 'remove'})
            end
        end
    end

    for k, v in pairs(eventActions) do
        for key, value in pairs(v) do
            if type(value) == "table" then 
                local id = value.ID
                ScenEdit_SetAction({description = id, mode = 'remove'})
            end
        end
    end
end

quote:

The RemoveEvent only deletes the event and can leave orphaned triggers, conditions, and actions. I got that. This is a bad thing.

quote:

The RemoveEventAndTCAs functions will delete the event and all TCAs connected to it in any way. This will include TCAs that may be shared with other events, which can cause them to error and abort your scripts. Clearly a bad thing.

quote:

The CleanupEvent function deletes the event and any TCAs that are connected to them AND share the same name. If the TCA that has the same name as the event happens to be used by another event, then that event will error out if called/triggered.

quote:

It seems to me that the whole area of events, trigers, conditions, and actions,is fairly complex and while it provides a great deal of flexibility, great care must be taken to keep these all straight and make sure that deletion happens correctly.

quote:

Aside from your suggestion above, which involves a recurring EventCleanup event and a global list of events for deletion, what is the best way to allow easy and safe cleanup of events (and their associared TCAs) allowing for the user to share TCAs?

quote:

I am thinking of startign with the CleanupEvent function, alter the parameter to a table and allow the user to specify the level and type of delete to perform.

{ name='eventName', delete=[eventOnly|allActions|namedActions|allTriggers|namedTriggers|allConditions|namedConditions|allTCAs|namedTCAs] }

Then based upon the delete parameter place the guid of the element on perform the appropriate delete list (event, trigger, condition, action), then every yea-often (perhaps 15 minutes) delete all the items on the delete lists..

--just pseudo code this ain't real and shows no error checking or mundane tasks.
function ProcessCleanUpCycle()
for g,entry in pairs(cleanupTable) do
   print(stringformat("Cleaning up %s with name %s",));
   curEvent = ScenEdit_GetEvent(g); 
   t = GetAllEventTriggers(curEvent)
   for _,t do RemoveTriggersFromEvent(curEvent,t); DeleteTriggers(entry.Ts); end
   c = GetAllEventConditions(curEvent)
   for _,c do RemoveConditionsFromEvent(curEvent,c); DeleteConditions(entry.Cs); end
   a = GetAllEventActions(curEvent)
   for _, a do RemoveActionsFromEvent(curEvent,a); DeleteActions(entry.As); end
   ScenEdit_SetEvent(guid,{Mode='remove'});
   print(string.format("Event  %s with name %s has been removed",tostring());
end

--just pseudo code this ain't real and shows no error checking or mundane tasks.
function GetAllEventTriggers(theEvent)
  local tbl = {};
  for every trigger listed in the event do
    table.insert(tbl,{guid=trigger.guid,name=trigger.description});
  end
  return tbl;
end

--pseudo sample
RemoveTriggersFromEvent(theEvent,theTriggers)
  for _,t in ipairs(theTriggers) do
     print(stringformat('Removing Trigger %s from event %s',tostring(t.name),tostring(theEvent.description))); --dbg
     ScenEdit_SetEventTrigger(theEvent.guid,{description=t.guid,Mode='remove'}
  end
end
 --pseudo sample
function DeleteTriggers(theEvent,TCAEntries)
  for _,tca in ipairs(TCAEntries) do
     print('Deleting Trigger: ' .. tostring(tca.name) ) --dbg
     ScenEdit_SetTrigger({description=tca.guid,Mode='remove'});
  end
end
--etc...

quote:

ORIGINAL: michaelm75au

Weird. I must be doing something wrong as this is working for me.
I took your script and uncommented line
--ScenEdit_SetEvent(event.guid, {mode = 'remove'})
And ran the script.
There are 4 events in editor and all were triggered. The units are moving.

quote:


6/7/2021 6:53:26 PM -- B1147.25 -- Collection was modified; enumeration operation may not execute.
Exception: Collection was modified; enumeration operation may not execute.
Stack Trace: at System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource)
at System.Collections.Generic.List`1.Enumerator.MoveNextRare()
at System.Collections.Generic.List`1.Enumerator.MoveNext()
at Command_Core.Scenario.(List`1 )
Call Stack & Error details:
Error at 101028,

quote:

ORIGINAL: KnightHawk75

quote:

ORIGINAL: michaelm75au

Weird. I must be doing something wrong as this is working for me.
I took your script and uncommented line
--ScenEdit_SetEvent(event.guid, {mode = 'remove'})
And ran the script.
There are 4 events in editor and all were triggered. The units are moving.

Yes I got that too... with only uncommenting that line.

BUT if you leave that commented and uncomment the line a few above it CleanupScriptEvent(sName) that basically does the same thing, you should get only the first event firing, along with the following in the exception log
for modifying the list during enumeration.

quote:


6/7/2021 6:53:26 PM -- B1147.25 -- Collection was modified; enumeration operation may not execute.
Exception: Collection was modified; enumeration operation may not execute.
Stack Trace: at System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource)
at System.Collections.Generic.List`1.Enumerator.MoveNextRare()
at System.Collections.Generic.List`1.Enumerator.MoveNext()
at Command_Core.Scenario.(List`1 )
Call Stack & Error details:
Error at 101028,

It is weird that a remove in the 'Start' function doesn't cause the exception, but does if outsourced to another, something I'm (or we're all missing) about this. hmm

quote:


That exception is what I would have expected if the event table was modified during execution.
I'll have a closer look at what that script is doing, but using the 'remove' itself seems to be okay. I thought that was suppose to give the same error

function ObfuscatedToHell_u001e (list<EventTrigger> Arg_1){
 try{
  --Arg_1 it would appear at a glance is a separately made copy\list.
  try{foreach(EventTrigger in Arg_1) {
    list<SimEvent> copyOfSimEventsAsList = ObservableDicSimEvents.Values.ToList() 
     --^this is a shallow copy but allows event deletion as list itself isn't changed just underlying ref'd content?
    try{ foreach(simevent in copyOfSimEventsAsList){
      -- if simEvent active proceed.. set reset Lua EventX var to this event.
      -- if simEvent.triggers?.contains(EventTrigger) ...proceed...
      -- processrandomnness setting if set... if set and grab random > set pct ...proceed... otherwise continue to next iteration.
      -- simEvent.ProcessConditions?(ScenarioContext) if end result is true proceed....  otherwise continue to next iteration
      --boatload of code to setting up some var and what not depending on the 'type' of trigger, ie UnitX\Y\C info. 

        try{ foreach(eventAction eventAction in simEvent.Actions){ 
           eventAction.RunAction?(scenariocontext,simEvent)
          -- YourCodeExecutingHere to delete this trigger and action it calls ScenEdit_SetEventXTCAX(remove) and ScenEdit_SetXTCAX(delete). 
          -- Those calls best I can tell operate on the original observabledics and they technically succeed.
          -- the action enumeration here is really tied to the original even though it looks like a copy.
          <--exception thrown here ( or at the top if you prefer, during next attempted iteration) 
           -- as the original Dictionary internal version 1 has changed to versionstamp 2 now.
          }
          continue; 
        }
        finally{dispose of related foreach enumerator actions} <--executes
      }
    }
    finally{dispose of related foreach enumerator simevents} <--executes
  } 
  finally{dispose of related foreach enumerator eventTriggers};<--executes 
 }
 catch(){ master catch, go log the exception} <--executes
}

quote:

ORIGINAL: michaelm75au

A fix to cater for 'deleting an action with an action' has been made for the next build.

quote:


Thanks KnightHawk75.
I will most likely lift this solution (with credit and somewhat modified) to use while I am compelled to use version 1 and change.