fix:! improve timer api

Author: bennett-sh

examples/main.ts

@@ -51,7 +51,10 @@ async function main() {
   // this will be added everytime it's called so you can modify it's value
   const myChangingBool = aChild.addBool(false)
   const myChangingInt = aChild.addInt(0, { name: 'A cool counter' })
-  const myTimer = aChild.addTimer(250, { SetTrue: [myChangingBool] })
+  const myTimer = aChild.addTimer({
+    time: { ms: 250 },
+    outputs: { SetTrue: myChangingBool }
+  })
 
   // get an existing entity
   // note: my_entity_id is neither a valid entity id nor existing in the agent47_default.entitytemplate

examples/outfit.ts

@@ -7,8 +7,11 @@ async function main() {
   const entity = patch.addEntity({ parent: CommonRoots.Agent47, ...CommonPaths.Entity })
 
   entity.setHeroOutfit('4d561409-84d4-4dae-abd2-852cf93471bb', modifier => ({
-    In: entity.addTimer(100, {
-      SetOutfit: modifier
+    In: entity.addTimer({
+      time: { ms: 100 },
+      outputs: {
+        SetOutfit: modifier
+      }
     })
   }))
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickentity-script",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "An easier way of writing QN patches with code",
   "main": "dist/src/lib.js",
   "types": "./dist/src/index.d.ts",

src/patches/entity/base.ts

@@ -264,8 +264,17 @@ export class PatchEntity {
     })
   }
 
-  public addTimer(timeMS: number, outputs: IEventTriggers, recursive = false, entityConfig: Partial<ICreateChildEntity> = {}) {
-    let { name, id } = entityConfig
+  public addTimer(options: {
+    time: Partial<{
+      ms: number,
+      seconds: number,
+      minutes: number
+    }>,
+    outputs: IEventTriggers,
+    recursive?: boolean,
+    entityConfig?: Partial<ICreateChildEntity>
+  }) {
+    let { name, id } = options.entityConfig ?? {}
     if(!name) name = 'Timer ' + generateRandomEntityName()
     if(!id) id = generateRandomEntityID()
     return this.addChild({
@@ -275,7 +284,7 @@ export class PatchEntity {
       properties: {
         'Delay time (ms)': {
           type: 'int32',
-          value: timeMS
+          value: (options.time.ms ?? 0) + (options.time.seconds ?? 0) * 1000 + (options.time.minutes ?? 0) * 60 * 1000
         },
         m_bEnabled: {
           type: 'bool',
@@ -284,8 +293,8 @@ export class PatchEntity {
       },
       events: {
         Out: {
-          ...outputsToEvent(outputs),
-          In: recursive ? id : []
+          ...outputsToEvent(options.outputs),
+          In: options.recursive ? id : []
         }
       }
     })

src/patches/entity/hero.ts

@@ -23,8 +23,11 @@ PatchEntity.prototype.getHero = function(triggers: IEventTriggers, entityConfig?
   })
 
   heroStandIn.addOnGameStartListener({
-    In: heroStandIn.addTimer(1000, {
-      GetHero: heroStandIn
+    In: heroStandIn.addTimer({
+      time: { seconds: 1 },
+      outputs: {
+        GetHero: heroStandIn
+      }
     })
   })
 

test/patch.test.js

@@ -78,7 +78,10 @@ describe('Simple Patch', () => {
   })
 
   const someBool = root.addBool(false)
-  const timer = root.addTimer(1250, { SetTrue: someBool })
+  const timer = root.addTimer({
+    time: { seconds: 1, ms: 250 },
+    outputs: { SetTrue: someBool }
+  })
 
   it('should add timers', () => {
     const build = patch.buildPatch()