feat(ecs): add basic component & entity structure

- as discussed add as an independent temporary folder "_ECS_WIP_TEMP"

Author: IllustrisJack

script/Core/Structures/Class.lua

@@ -6,7 +6,7 @@
 
   Example:
 
-    local Ship = class(function (self, name, hp)
+    local Ship = Class(function (self, name, hp)
       self.name = name
       self.health = hp
       self.healthMax = hp
@@ -15,7 +15,7 @@
     function Ship:addHangar (unit) assert(false, "No hangar!") end
     function Ship:getHangar () return {} end
 
-    local Carrier = subclass(Ship, function (self)
+    local Carrier = Subclass(Ship, function (self)
       self.hanger = {}
     end)
 
@@ -24,7 +24,7 @@
 ----------------------------------------------------------------------------]]
 --
 
-function class(ctor)
+function Class(ctor)
     local cls = {}
     cls.__index = cls
     setmetatable(cls, {
@@ -38,7 +38,7 @@ function class(ctor)
     return cls
 end
 
-function subclass(base, ctor)
+function Subclass(base, ctor)
     local cls = {}
     cls.__index = cls
     setmetatable(cls, {

script/Core/Structures/List.lua

@@ -3,7 +3,7 @@
   Includes some useful generic algorithms for common linear list operations.
 ----------------------------------------------------------------------------]]
 --
-local List = class(function(self, ...)
+local List = Class(function(self, ...)
     local args = { ... }
     for i = 1, #args do
         self[i] = args[i]

script/Core/Structures/Map.lua

@@ -1,4 +1,4 @@
-local Map = class(function(self, ctor)
+local Map = Class(function(self, ctor)
     self.__ctor = ctor
 end)
 

script/Core/Util/Distribution.lua

@@ -8,7 +8,7 @@
   TODO : Implement Alias Method for O(1) sampling. Sampling is currently O(n).
 ----------------------------------------------------------------------------]]
 
-local Distribution = class(function(self)
+local Distribution = Class(function(self)
     self.values = {}
     self.weights = {}
 end)

script/Core/Util/Iterator.lua

@@ -1,3 +1,4 @@
+---@class Iterator
 function Iterator(t)
     local i = 0
     local n = #t
@@ -7,6 +8,16 @@ function Iterator(t)
     end
 end
 
+---@class IteratorIndexed
+function IteratorIndexed(t)
+    local i = 0
+    local n = #t
+    return function()
+        i = i + 1
+        if i <= n then return i, t[i] end
+    end
+end
+
 --[[
     example of usage:
 

script/Enums/EntityType.lua

@@ -1,7 +1,30 @@
+---@enum EntityType
 Enums.EntityType = {
-    Player = 1,
-    Station = 2,
-    Ship = 3,
-    Component = 4,
-    Faction = 5
-}
+    Unknown = 1,
+    Reserved = 2,
+    StarSector = 3,
+    StarSystem = 4,
+    Zone = 5,
+    Star = 6,
+    Planet = 7,
+    Colony = 8,
+    Station = 9,
+    Ship = 10,
+    Asteroid = 11,
+    Player = 12
+}
+
+Enums.EntityTypeNames = {
+    "Unknown",
+    "Reserved",
+    "StarSector",
+    "StarSystem",
+    "Zone",
+    "Star",
+    "Planet",
+    "Colony",
+    "Station",
+    "Ship",
+    "Asteroid",
+    "Player"
+}

script/GameObjects/Action.lua

@@ -14,7 +14,7 @@
 ----------------------------------------------------------------------------]]
 --
 
-local Action = class(function(self) end)
+local Action = Class(function(self) end)
 
 -- Virtual ---------------------------------------------------------------------
 

script/GameObjects/Actions/Attack.lua

@@ -4,7 +4,7 @@ local SocketType = require('GameObjects.Entities.Ship.SocketType')
 -- temp settings
 local outOfRangeCancel = 30
 
-local Attack = subclass(Action, function(self, target)
+local Attack = Subclass(Action, function(self, target)
     self.target = target
 end)
 

script/GameObjects/Actions/CriminalThink.lua

@@ -3,7 +3,7 @@ local Player = require('GameObjects.Entities.Player')
 
 -- Temporary File until other systems are more fleshed out, to be merged into a general AI script that handles all the THINKING
 
-local CriminalThink = subclass(Action, function(self)
+local CriminalThink = Subclass(Action, function(self)
     self.timer = 0
     self.rng = RNG.FromTime()
 end)

script/GameObjects/Actions/DockAt.lua

@@ -5,7 +5,7 @@ local rng = RNG.FromTime()
 -- TODO : Dock range should be specified by the dockable component
 local kDockRange = 2000 -- ships are getting "stuck" at 250
 
-local DockAt = subclass(Action, function(self, target)
+local DockAt = Subclass(Action, function(self, target)
     self.target = target
 end)
 

script/GameObjects/Actions/Escort.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local Escort = subclass(Action, function(self, target, offset)
+local Escort = Subclass(Action, function(self, target, offset)
     self.target = target
     self.offset = offset
 end)

script/GameObjects/Actions/MaraudAt.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local MaraudAt = subclass(Action, function(self, zone, radius)
+local MaraudAt = Subclass(Action, function(self, zone, radius)
     self.radius = radius
     self.targetPosition = nil
     self.system = nil

script/GameObjects/Actions/MineAt.lua

@@ -3,7 +3,7 @@ local Action = require('GameObjects.Action')
 local kLeadTime = 1.0
 local orbitTime = 30
 
-local MineAt = subclass(Action, function(self, source, target, miningTimePerItem)
+local MineAt = Subclass(Action, function(self, source, target, miningTimePerItem)
     assert(source:hasYield())
     self.source = source
     self.target = target

script/GameObjects/Actions/MoveTo.lua

@@ -4,7 +4,7 @@ local Action = require('GameObjects.Action')
 local rng = RNG.FromTime()
 local timeUntilTravelDrive = 15 -- temporary local setting
 
-local MoveTo = subclass(Action, function(self, target, range, useTravelDrive)
+local MoveTo = Subclass(Action, function(self, target, range, useTravelDrive)
     self.target = target
     self.range = range
     self.useTravelDrive = useTravelDrive

script/GameObjects/Actions/MoveToPos.lua

@@ -4,7 +4,7 @@ local Action = require('GameObjects.Action')
 local rng = RNG.FromTime()
 local timeUntilTravelDrive = 15 -- temporary local setting
 
-local MoveToPos = subclass(Action, function(self, targetPos, range, useTravelDrive)
+local MoveToPos = Subclass(Action, function(self, targetPos, range, useTravelDrive)
     self.targetPos = targetPos
     self.range = range
     self.useTravelDrive = useTravelDrive

script/GameObjects/Actions/Orbit.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local Orbit = subclass(Action, function(self, target, radius, orbitTime)
+local Orbit = Subclass(Action, function(self, target, radius, orbitTime)
     self.target = target
     self.orbitRadius = radius
     self.orbitTime = orbitTime

script/GameObjects/Actions/Patrol.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local Patrol = subclass(Action, function(self, patrolNodes)
+local Patrol = Subclass(Action, function(self, patrolNodes)
     self.patrolNodes = patrolNodes
     self.patrolCurrentNodeIndex = 1
     self.system = nil

script/GameObjects/Actions/Repeat.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local Repeat = subclass(Action, function(self, actions)
+local Repeat = Subclass(Action, function(self, actions)
     self.actions = actions
 end)
 

script/GameObjects/Actions/Think.lua

@@ -1,7 +1,7 @@
 local Action = require('GameObjects.Action')
 local Player = require('GameObjects.Entities.Player')
 
-local Think = subclass(Action, function(self)
+local Think = Subclass(Action, function(self)
     self.timer = 0
     self.rng = RNG.FromTime()
 end)
@@ -51,7 +51,7 @@ function Think:manageAsset(asset)
         asset:pushAction(bestJob)
     end
 end
-]]--
+]] --
 
 -- Use payout, not flow
 function Think:manageAsset(asset)

script/GameObjects/Actions/Undock.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local Undock = subclass(Action, function(self) end)
+local Undock = Subclass(Action, function(self) end)
 
 function Undock:clone()
     return Undock()

script/GameObjects/Actions/Wait.lua

@@ -1,6 +1,6 @@
 local Action = require('GameObjects.Action')
 
-local Wait = subclass(Action, function(self, duration)
+local Wait = Subclass(Action, function(self, duration)
     self.duration = duration
     self.t = 0
 end)

script/GameObjects/Elements/Components/Armor.lua

@@ -1,7 +1,7 @@
 local Entity = require('GameObjects.Entity')
 local SocketType = require('GameObjects.Entities.Ship.SocketType')
 
-local Armor = subclass(Entity, function(self)
+local Armor = Subclass(Entity, function(self)
     self.name       = Config.gen.compArmorStats.name
     self.healthCurr = Config.gen.compArmorStats.healthCurr
     self.healthMax  = Config.gen.compArmorStats.healthMax

script/GameObjects/Elements/Components/Capacitor.lua

@@ -17,7 +17,7 @@ local Bindings    = require('States.ApplicationBindings')
 local shared
 local rng         = RNG.FromTime()
 
-local Capacitor   = subclass(Entity, function(self)
+local Capacitor   = Subclass(Entity, function(self)
     -- All of this crap is completely worthless, but updateCapacitor() will not be called without it
     if not shared then
         shared = {}

script/GameObjects/Elements/Components/Cloak.lua

@@ -5,7 +5,7 @@ local SocketType  = require('GameObjects.Entities.Ship.SocketType')
 local shared
 local rng         = RNG.FromTime()
 
-local Cloak       = subclass(Entity, function(self)
+local Cloak       = Subclass(Entity, function(self)
     -- All of this crap is completely worthless, but updateCloak() will not be called without it
     if not shared then
         shared = {}

script/GameObjects/Elements/Components/Communicator.lua

@@ -5,7 +5,7 @@ local SocketType   = require('GameObjects.Entities.Ship.SocketType')
 local shared
 local rng          = RNG.FromTime()
 
-local Communicator = subclass(Entity, function(self)
+local Communicator = Subclass(Entity, function(self)
     -- All of this crap is completely worthless, but updateCommunicator() will not be called without it
     if not shared then
         shared = {}

script/GameObjects/Elements/Components/Computer.lua

@@ -5,7 +5,7 @@ local SocketType  = require('GameObjects.Entities.Ship.SocketType')
 local shared
 local rng         = RNG.FromTime()
 
-local Computer    = subclass(Entity, function(self)
+local Computer    = Subclass(Entity, function(self)
     -- All of this crap is completely worthless, but updateComputer() will not be called without it
     if not shared then
         shared = {}

script/GameObjects/Elements/Components/Hull.lua

@@ -1,7 +1,7 @@
 local Entity = require('GameObjects.Entity')
 local SocketType = require('GameObjects.Entities.Ship.SocketType')
 
-local Hull = subclass(Entity, function(self)
+local Hull = Subclass(Entity, function(self)
     self.name       = Config.gen.compHullStats.name
     self.healthCurr = Config.gen.compHullStats.healthCurr
     self.healthMax  = Config.gen.compHullStats.healthMax

script/GameObjects/Elements/Components/Inventory.lua

@@ -5,7 +5,7 @@ local SocketType  = require('GameObjects.Entities.Ship.SocketType')
 local shared
 local rng         = RNG.FromTime()
 
-local Inventory   = subclass(Entity, function(self)
+local Inventory   = Subclass(Entity, function(self)
     -- Required to be able to use plugs
     if not shared then
         shared = {}

script/GameObjects/Elements/Components/Sensor.lua

@@ -5,7 +5,7 @@ local SocketType  = require('GameObjects.Entities.Ship.SocketType')
 local shared
 local rng         = RNG.FromTime()
 
-local Sensor      = subclass(Entity, function(self)
+local Sensor      = Subclass(Entity, function(self)
     -- All of this crap is completely worthless, but updateSensor() will not be called without it
     if not shared then
         shared = {}

script/GameObjects/Elements/Components/Shield.lua

@@ -20,7 +20,7 @@ local Bindings    = require('States.ApplicationBindings')
 local shared
 local rng         = RNG.FromTime()
 
-local Shield      = subclass(Entity, function(self)
+local Shield      = Subclass(Entity, function(self)
     -- All of this crap is completely worthless, but updateShield() will not be called without it
     if not shared then
         shared = {}

script/GameObjects/Elements/Economy/BlackMarket.lua

@@ -38,7 +38,7 @@ local function addOrder(type, self, actor, item, count, price)
     sort(orders, type.comparator)
 end
 
-local BlackMarket = class(function(self)
+local BlackMarket = Class(function(self)
     self.data = {}
     self.escrow = {}
 end)

script/GameObjects/Elements/Economy/Economy.lua

@@ -11,7 +11,7 @@ local updateRates = {
     [4] = 2  -- Patrolling
 }
 
-local Economy = class(function(self, parent)
+local Economy = Class(function(self, parent)
     self.parent = parent
     self.factories = {}
     self.flows = {}

script/GameObjects/Elements/Economy/Factory.lua

@@ -3,7 +3,7 @@ local Item = require('Systems.Economy.Item')
 
 --------------------------------------------------------------------------------
 
-local Factory = class(function(self, parent)
+local Factory = Class(function(self, parent)
     self.parent = parent
     self.prods = {}
     self.time = 0

script/GameObjects/Elements/Economy/Market.lua

@@ -38,7 +38,7 @@ local function addOrder(type, self, actor, item, count, price)
     sort(orders, type.comparator)
 end
 
-local Market = class(function(self)
+local Market = Class(function(self)
     self.data = {}
     self.escrow = {}
 end)

script/GameObjects/Elements/Economy/Yield.lua

@@ -3,7 +3,7 @@ local Entity = require('GameObjects.Entity')
 -- NOTE : The 'size' of an entity's yield serves as a rate limiter. No more
 -- than 'size' (energy-normalized) units of item may be extracted per
 -- unit time from the Entity.
-local Yield = class(function(self, item, size)
+local Yield = Class(function(self, item, size)
     self.item     = item
     self.size     = size
     self.maxSize  = size

script/GameObjects/Elements/NPC/BlackMarketTrader.lua

@@ -7,7 +7,7 @@ local Item = require('Systems.Economy.Item')
 -- NOTE: All the evaluations below are made from the perspective of what is most
 -- advantageous to _this trader_ (self).
 
-local BlackMarketTrader = class(function(self, parent)
+local BlackMarketTrader = Class(function(self, parent)
     self.parent = parent
     self.elems = {}
 end)