diff --git a/goal_src/jak2/engine/common_objs/elevator.gc b/goal_src/jak2/engine/common_objs/elevator.gc index f948348944..da09f635b6 100644 --- a/goal_src/jak2/engine/common_objs/elevator.gc +++ b/goal_src/jak2/engine/common_objs/elevator.gc @@ -381,7 +381,7 @@ (defmethod find-closest-point-in-path! ((this elevator) (arg0 vector) (arg1 (pointer float)) (arg2 symbol) (arg3 symbol)) "Finds and sets the provided [[path-step]]'s `next-pos` field to the vertex index in the path which is closest to the provided [[vector]] - + @param vec The point at which distance calculations are based off @param! next-step If a point is found, `next-pos` will be set to the correct point @param arg2 TODO @@ -703,7 +703,7 @@ (defmethod calc-dist-between-points! ((this elevator) (path-point-x int) (path-point-y int)) "Calculates the distance between two points in the elevator's path. - + @param path-point-x The index of the first point in the distance calculation, and where `next-pos` and `dist` are stored in the `path-seq` array @param path-point-y The second point in the distance calculation" (set! (-> this path-seq data path-point-x next-pos) (the float path-point-y)) diff --git a/goal_src/jak2/engine/debug/memory-usage.gc b/goal_src/jak2/engine/debug/memory-usage.gc index c8e562c623..b105c75eb8 100644 --- a/goal_src/jak2/engine/debug/memory-usage.gc +++ b/goal_src/jak2/engine/debug/memory-usage.gc @@ -81,7 +81,7 @@ (defmethod compute-memory-usage! ((this level) (force? symbol)) "Calculates the memory usage of the level, returns and stores the [[memory-usage-block]] in `mem-usage-block` as well as the total size in `mem-usage` - + @param force? - Will re-compute the usage if set to [[#t]], even if `mem-usage` has been set to a non-zero value @returns The [[memory-usage-block]] representing the footprint of the level @see [[memory-usage-block::10]]" diff --git a/goal_src/jak2/engine/entity/res.gc b/goal_src/jak2/engine/entity/res.gc index e0b9a0f4a1..2d53a508b8 100644 --- a/goal_src/jak2/engine/entity/res.gc +++ b/goal_src/jak2/engine/entity/res.gc @@ -137,7 +137,7 @@ This is updated from the entity system used in Crash 2, which had most of these Correct lookups return a res-tag-pair, which contains one tag index in the lower 32 bits and one in the upper 32 bits. Depending on the mode, they may be the same, or they may be two tags that you should interpolate between, if the exact time was not found. - + @param name-sym should be the name of the thing you want. @param time is for the timestamp you want. If mode = 'base, then both the indices are the same and the timestamp is ignored. diff --git a/goal_src/jak2/engine/gfx/foreground/ripple.gc b/goal_src/jak2/engine/gfx/foreground/ripple.gc index f47b9627fd..d5703ca663 100644 --- a/goal_src/jak2/engine/gfx/foreground/ripple.gc +++ b/goal_src/jak2/engine/gfx/foreground/ripple.gc @@ -27,7 +27,7 @@ (defun ripple-make-request ((waveform ripple-wave) (effect merc-effect)) "Iterate through [[*ripple-globals*]] `requests` looking for the one that matches the provided `effect` If NOT found, append a new [[ripple-request]] with the providded `effect` and `waveform` to the end of the `requests`. - + NOTE: There can only be 16 effects at a given time, NOOP if already at that limit!" (let ((v1-1 (-> *ripple-globals* count)) (a2-1 (-> *ripple-globals* requests)) @@ -76,7 +76,7 @@ "Iterate through [[*ripple-globals*]] requests, from the end to index `0` For each request, if it has a `waveform` create the wave-table via `ripple-create-wave-table` Then for each `waveform` apply the `effect` using `ripple-apply-wave-table` - + Once completed, all `requests` have been processed and the `count` is reset to `0`" (when (-> *ripple-globals* count) (ripple-execute-init) diff --git a/goal_src/jak2/engine/level/region.gc b/goal_src/jak2/engine/level/region.gc index ba1d70b9df..d9f8780b6a 100644 --- a/goal_src/jak2/engine/level/region.gc +++ b/goal_src/jak2/engine/level/region.gc @@ -160,7 +160,7 @@ (defmethod track-entered-region! ((this region-prim-area) (region-sphere drawable-region-sphere)) "Enumerates through the objects `region-enter-list`, if we find the provided `region`, do nothing and exit otherwise, add the [[drawable-region-sphere]] to `region-enter-prim-list` and increment `region-enter-count` - + @param region-sphere Defines the region in question @returns nothing" (let ((regions-entered (-> this region-enter-count))) @@ -183,7 +183,7 @@ (defmethod track-exited-region! ((this region-prim-area) (arg0 drawable-region-sphere)) "Enumerates through the objects `region-exit-list`, if we find the provided `region`, do nothing and exit otherwise, add the [[drawable-region-sphere]] to `region-exit-prim-list` and increment `region-exit-count` - + @param region-sphere Defines the region in question @returns nothing" (let ((regions-exited (-> this region-exit-count))) @@ -206,7 +206,7 @@ (defmethod track-inside-region! ((this region-prim-area) (arg0 drawable-region-sphere)) "Enumerates through the objects `region-inside-list`, if we find the provided `region`, do nothing and exit otherwise, add the [[drawable-region-sphere]] to `region-inside-prim-list` and increment `region-inside-count` - + @param region-sphere Defines the region in question @returns nothing" (let ((regions-inside (-> this region-inside-count))) @@ -229,7 +229,7 @@ (defmethod track-start-region! ((this region-prim-area) (arg0 drawable-region-sphere)) "Enumerates through the objects `region-start-list`, if we find the provided `region`, do nothing and exit otherwise, add the [[drawable-region-sphere]] to `region-start-prim-list` and increment `region-start-count` - + @param region-sphere Defines the region in question @returns nothing" (let ((regions-started (-> this region-start-count))) diff --git a/goal_src/jak2/levels/common/elec-gate.gc b/goal_src/jak2/levels/common/elec-gate.gc index a8afce3086..2870e05bc2 100644 --- a/goal_src/jak2/levels/common/elec-gate.gc +++ b/goal_src/jak2/levels/common/elec-gate.gc @@ -711,7 +711,7 @@ (defmethod set-state! ((this elec-gate)) "If either [[actor-option::17]] is set on the [[elec-gate]] or the related subtask is completed make the gate `idle`. - + Otherwise, the gate will be `active`." (if (or (logtest? (actor-option user17) (-> this fact options)) (and (-> this entity) (logtest? (-> this entity extra perm status) (entity-perm-status subtask-complete))) diff --git a/goal_src/jak2/levels/fortress/rescue/forresca-obs.gc b/goal_src/jak2/levels/fortress/rescue/forresca-obs.gc index 6178a8f071..84af2e6cf1 100644 --- a/goal_src/jak2/levels/fortress/rescue/forresca-obs.gc +++ b/goal_src/jak2/levels/fortress/rescue/forresca-obs.gc @@ -360,7 +360,7 @@ (defmethod set-state! ((this elec-lock-gate)) "If either [[actor-option::17]] is set on the [[elec-gate]] or the related subtask is completed make the gate `idle`. - + Otherwise, the gate will be `active`." (if (elec-lock-gate-method-31 this #f) (go (method-of-object this shutdown)) diff --git a/goal_src/jak2/levels/mountain/mountain-scenes.gc b/goal_src/jak2/levels/mountain/mountain-scenes.gc index 7b16f64307..81d7e112bb 100644 --- a/goal_src/jak2/levels/mountain/mountain-scenes.gc +++ b/goal_src/jak2/levels/mountain/mountain-scenes.gc @@ -1788,7 +1788,7 @@ (defmethod plat-path-sync ((this mtn-plat-buried)) "If the `sync` period is greater than `0` then transition the state to [[plat::35]] otherwise, [[plat::34]] - + @see [[sync-eased]]" (cond ((or (logtest? (-> this path flags) (path-control-flag not-found)) diff --git a/goal_src/jak2/levels/under/under-sig-obs.gc b/goal_src/jak2/levels/under/under-sig-obs.gc index e65e8b87dd..145c180b29 100644 --- a/goal_src/jak2/levels/under/under-sig-obs.gc +++ b/goal_src/jak2/levels/under/under-sig-obs.gc @@ -389,7 +389,7 @@ (defmethod plat-path-sync ((this under-plat-shoot)) "If the `sync` period is greater than `0` then transition the state to [[plat::35]] otherwise, [[plat::34]] - + @see [[sync-eased]]" (cond ((and (script-eval (the-as pair (-> this draw-test-script))) (= *bot-record-path* -1))