Add new TS1 lot loader, fix FSO lighting

Still need to inherit neighbours on lot load, figure out what happens with vacation saves.

FSO lighting for windows has been kind of broken for a while, this should fix it.

Author: riperiperi

TSOClient/FSO.IDE/EntityInspector.cs

@@ -62,7 +62,7 @@ public void GetEntityList(List<InspectorEntityMeta> list)
                     Entity = entity,
                     ID = entity.ObjectID,
                     Name = entity.ToString(),
-                    MultitileLead = entity.MultitileGroup.BaseObject.ObjectID,
+                    MultitileLead = entity.MultitileGroup.BaseObject?.ObjectID ?? 0,
                     Container = (entity.Container == null) ? (short)0 : entity.Container.ObjectID,
                     Slot = entity.ContainerSlot
                 });

TSOClient/FSO.IDE/Utils/HouseSpy.cs

@@ -184,7 +184,7 @@ private ListViewItem GetInteraction(string type, OBJMInteraction action)
                     action.Priority.ToString(),
                     action.ActionTreeID.ToString(),
                     action.Attenuation.ToString(),
-                    action.Flags.ToString(),
+                    ((int)action.Flags).ToString(),
                 });
 
             if (type == "#")
@@ -267,7 +267,7 @@ public void RedrawSelectedPerson()
                 motiveChangeList.Items.Add(new ListViewItem(new string[]
                 {
                     ((VMMotive)delta.Motive).ToString(),
-                    (delta.TickDelta * 18000).ToString(),
+                    (delta.TickDelta * 1800).ToString(),
                     delta.StopAt.ToString()
                 }));
             }

TSOClient/tso.files/Formats/IFF/Chunks/OBJM.cs

@@ -58,7 +58,7 @@ public OBJMFootprint(IffFieldEncode iop)
     public struct OBJMMotiveDelta
     {
         public int Motive;
-        public float TickDelta; // 30 ticks per minute, 60 ticks per hour
+        public float TickDelta; // 30 ticks per minute, 60 minutes per hour
         public float StopAt;
 
         public OBJMMotiveDelta(IffFieldEncode iop)
@@ -69,6 +69,31 @@ public OBJMMotiveDelta(IffFieldEncode iop)
         }
     }
 
+    [Flags]
+    public enum OBJMInteractionFlags
+    {
+        AutoFirst = 1,
+        PushHeadContinuation = 2,
+        UserInitiated = 4, // Interaction is not autonomous. Can be 0 for primitive pushed interactions until they actually run.
+        CanBeAuto = 8, // check tree succeeds with param 0 == 1
+        // 16: appears on goto work, group meal (push interaction? inherited? custom icon? doesn't show on person to person...)
+        Unknown16 = 16, // Something to do with interaction push
+        Completed = 32,
+        CarryNameOver = 64,
+        // 128: unknown - when non-active chars get called to meals (or carpool) this flag is set
+        Unknown128 = 128, // Something to do with interaction push
+        UserInterrupted = 256 // When the interaction has the X over it.
+    }
+
+    public enum OBJMRoutingState
+    {
+        None = 0,
+        Stopped = 3,
+        Turning = 4,
+        Accelerating = 6,
+        Walking = 9
+    }
+
     public struct OBJMInteraction
     {
         public int UID;
@@ -80,16 +105,13 @@ public struct OBJMInteraction
         public int Priority;
         public short ActionTreeID;
         public float Attenuation;
+        public OBJMInteractionFlags Flags;
 
-        // 1: unknown
-        // 2: appears on group meal continuation
-        // 4: user initiated? also appears for social interactions from other sim, but those use push interaction
-        // 8: seems to randomly disappear (not on mourn/go here, is on "sit")
-        // 16: appears on goto work, group meal continuation
-        // 32: appears when the interaction becomes a "last interaction"?
-        // 64: appears on goto work
-        // 256: manually interrupted (not just priority override)
-        public int Flags;
+        // called to group meal (28, prio 50) 4 + 8 + 16
+        // picked up single meal (child) (30)
+        // picked up single meal (adult) (158)
+        // mama autos to group meal (129)
+        // mama picked up group meal (158)
 
         public OBJMInteraction(IffFieldEncode iop)
         {
@@ -114,7 +136,7 @@ public OBJMInteraction(IffFieldEncode iop)
             Priority = iop.ReadInt32();
             ActionTreeID = iop.ReadInt16();
             Attenuation = iop.ReadFloat();
-            Flags = iop.ReadInt32();
+            Flags = (OBJMInteractionFlags)iop.ReadInt32();
         }
 
         public bool IsValid()
@@ -176,7 +198,7 @@ public struct OBJMPerson
         public string CarryAnimation; //
         public string BaseAnimation; //a2o-standing-loop;-10;1000;70;1000;1;1;1
 
-        public int RoutingState;
+        public OBJMRoutingState RoutingState;
         public float[] FirstFloats;
         public float[] MotiveDataOld;
         public float[] MotiveData;
@@ -223,13 +245,7 @@ public OBJMPerson(uint version, IffFieldEncode iop)
             CarryAnimation = iop.ReadString(false); //a2o-rarm-carry-loop;10;0;1000;1000;0;1;1
             BaseAnimation = iop.ReadString(true); //a2o-standing-loop;-10;1000;525;1000;1;1;1
 
-            RoutingState = iop.ReadInt32();
-            // Seems to be related to routing
-            // 9: actively moving to dest?
-            // 6: accelerating
-            // 4: turning?
-            // 3: stopped? this seems to linger when sims go to work
-            // 0: no movement (maybe resets when scripted animation starts)
+            RoutingState = (OBJMRoutingState)iop.ReadInt32();
 
             FirstFloats = new float[9];
 

TSOClient/tso.simantics/Engine/VMStackFrame.cs

@@ -4,6 +4,13 @@
 
 namespace FSO.SimAntics.Engine
 {
+    public enum VMSpecialResult
+    {
+        Normal,
+        Interaction,
+        Retry
+    }
+
     /// <summary>
     /// Holds information about the execution of a routine
     /// </summary>
@@ -48,8 +55,11 @@ public short StackObjectID
         private VMEntity _StackObject;
         public short _StackObjectID;
 
-        /** If true, this stack frame is not a subroutine. Return with a continue. **/
-        public bool DiscardResult;
+        /** 
+         * Normally, returning true or false from a stack frame goes to the corresponding node on the parent frame.
+         * This works differently for interactions, and for TS1 loaded trees. (no routing frames, needs to rerun the route primitive)
+         */
+        public VMSpecialResult SpecialResult;
 
         /** Indicates that the current stack frame is part of an action tree.
          ** Set by "idle for input, allow push", when an interaction is selected.
@@ -137,7 +147,7 @@ public virtual VMStackFrameMarshal Save()
                 CodeOwnerGUID = CodeOwner.OBJ.GUID,
                 Locals = (short[])Locals?.Clone(),
                 Args = (short[])Args?.Clone(),
-                DiscardResult = DiscardResult,
+                SpecialResult = SpecialResult,
                 ActionTree = ActionTree,
             };
         }
@@ -165,7 +175,7 @@ public virtual void Load(VMStackFrameMarshal input, VMContext context)
                 Locals = input.Locals;
             }
             Args = input.Args;
-            DiscardResult = input.DiscardResult;
+            SpecialResult = input.SpecialResult;
             ActionTree = input.ActionTree;
         }
 

TSOClient/tso.simantics/Engine/VMThread.cs

@@ -236,7 +236,7 @@ public void TryRunImmediately()
                     {
                         Queue.Insert(ActiveQueueBlock+1, temp);
                         var frame = temp.ToStackFrame(Entity);
-                        frame.DiscardResult = true;
+                        frame.SpecialResult = VMSpecialResult.Interaction;
                         Push(frame);
                         ActiveQueueBlock++; //both the run immediately interaction and the active interaction must be protected.
                         break;
@@ -273,7 +273,7 @@ private void EndCurrentInteraction()
         public void AbortCurrentInteraction()
         {
             //go all the way back to the stack frame that Allow Push'd us.
-            var returnTo = Stack.FindLast(x => x.DiscardResult);
+            var returnTo = Stack.FindLast(x => x.SpecialResult == VMSpecialResult.Interaction);
             if (returnTo != null)
             {
                 var ind = Stack.IndexOf(returnTo);
@@ -704,17 +704,22 @@ public void Breakpoint(VMStackFrame frame, string description)
 
         public void Pop(VMPrimitiveExitCode result)
         {
-            var discardResult = Stack[Stack.Count - 1].DiscardResult;
+            var discardResult = Stack[Stack.Count - 1].SpecialResult;
             var contextSwitch = (Stack.Count > 1) && Stack.LastOrDefault().ActionTree != Stack[Stack.Count - 2].ActionTree;
             Stack.RemoveAt(Stack.Count - 1);
             LastStackExitCode = result;
 
-            if (discardResult) //interaction switching back to main (it cannot be the other way...)
+            if (discardResult == VMSpecialResult.Interaction) //interaction switching back to main (it cannot be the other way...)
             {
                 var interaction = Queue[ActiveQueueBlock];
                 EndCurrentInteraction();
                 result = (!interaction.Flags.HasFlag(TTABFlags.RunImmediately)) ? VMPrimitiveExitCode.CONTINUE_NEXT_TICK : VMPrimitiveExitCode.CONTINUE;
             }
+            else if (discardResult == VMSpecialResult.Retry)
+            {
+                result = VMPrimitiveExitCode.CONTINUE;
+            }
+
             if (Stack.Count > 0)
             {
                 if (result == VMPrimitiveExitCode.RETURN_TRUE)
@@ -869,7 +874,7 @@ private bool ExecuteAction(VMQueuedAction action)
             //set the new interaction's priority
             ((VMAvatar)Entity).SetPersonData(VMPersonDataVariable.Priority, action.Priority);
             var frame = action.ToStackFrame(Entity);
-            frame.DiscardResult = true;
+            frame.SpecialResult = VMSpecialResult.Interaction;
             return Push(frame);
         }
 

TSOClient/tso.simantics/Entities/VMAvatar.cs

@@ -958,6 +958,7 @@ public void InheritNeighbor(Neighbour neigh, FAMI current)
             else SetPersonData(VMPersonDataVariable.PersonType, lastPersonType);
             SetPersonData(VMPersonDataVariable.VisitorSchedule, sched);
             SetPersonData(VMPersonDataVariable.GreetStatus, 0);
+            SetPersonData(VMPersonDataVariable.IsGhost, GetPersonData(VMPersonDataVariable.IsGhost));
         }
 
         public virtual short GetMotiveData(VMMotive variable) //needs special conditions for ones like Mood.

TSOClient/tso.simantics/FSO.SimAntics.csproj

@@ -410,6 +410,7 @@
     <Compile Include="Utils\VMLotRotate.cs" />
     <Compile Include="Utils\VMLotTerrainRestoreTools.cs" />
     <Compile Include="Utils\VMTS1Activator.cs" />
+    <Compile Include="Utils\VMTS1ActivatorNew.cs" />
     <Compile Include="Utils\VMTS1PurchasableOutfitHelper.cs" />
     <Compile Include="Utils\VMWorldActivator.cs" />
     <Compile Include="Utils\VMWorldExporter.cs" />

TSOClient/tso.simantics/Marshals/Threads/VMStackFrameMarshal.cs

@@ -1,4 +1,5 @@
-using FSO.SimAntics.NetPlay.Model;
+using FSO.SimAntics.Engine;
+using FSO.SimAntics.NetPlay.Model;
 using System.IO;
 
 namespace FSO.SimAntics.Marshals.Threads
@@ -13,7 +14,7 @@ public class VMStackFrameMarshal : VMSerializable
         public uint CodeOwnerGUID;
         public short[] Locals;
         public short[] Args;
-        public bool DiscardResult;
+        public VMSpecialResult SpecialResult;
         public bool ActionTree;
 
         public int Version;
@@ -44,7 +45,7 @@ public virtual void Deserialize(BinaryReader reader)
                 for (int i = 0; i < argsN; i++) Args[i] = reader.ReadInt16();
             }
 
-            if (Version > 3) DiscardResult = reader.ReadBoolean();
+            if (Version > 3) SpecialResult = (VMSpecialResult)reader.ReadByte();
             ActionTree = reader.ReadBoolean();
         }
 
@@ -60,7 +61,7 @@ public virtual void SerializeInto(BinaryWriter writer)
             if (Locals != null) writer.Write(VMSerializableUtils.ToByteArray(Locals));
             writer.Write((Args == null) ? -1 : Args.Length);
             if (Args != null) writer.Write(VMSerializableUtils.ToByteArray(Args));
-            writer.Write(DiscardResult);
+            writer.Write((byte)SpecialResult);
             writer.Write(ActionTree);
         }
     }

TSOClient/tso.simantics/NetPlay/Model/Commands/VMBlueprintRestoreCmd.cs

@@ -51,7 +51,8 @@ public override bool Execute(VM vm)
                 }
                 else
                 {
-                    var activator = new VMTS1Activator(vm, vm.Context.World, JobLevel);
+                    //var activator = new VMTS1Activator(vm, vm.Context.World, JobLevel);
+                    var activator = new VMTS1ActivatorNew(vm, JobLevel);
                     activator.LoadFromIff(iff);
                 }