Files
jak-project/goal_src/jak1/engine/entity/entity-h.gc
T
ManDude cd68cb671e deftype and defmethod syntax major changes (#3094)
Major change to how `deftype` shows up in our code:
- the decompiler will no longer emit the `offset-assert`,
`method-count-assert`, `size-assert` and `flag-assert` parameters. There
are extremely few cases where having this in the decompiled code is
helpful, as the types there come from `all-types` which already has
those parameters. This also doesn't break type consistency because:
  - the asserts aren't compared.
- the first step of the test uses `all-types`, which has the asserts,
which will throw an error if they're bad.
- the decompiler won't emit the `heap-base` parameter unless necessary
now.
- the decompiler will try its hardest to turn a fixed-offset field into
an `overlay-at` field. It falls back to the old offset if all else
fails.
- `overlay-at` now supports field "dereferencing" to specify the offset
that's within a field that's a structure, e.g.:
```lisp
(deftype foobar (structure)
  ((vec    vector  :inline)
   (flags  int32   :overlay-at (-> vec w))
   )
  )
```
in this structure, the offset of `flags` will be 12 because that is the
final offset of `vec`'s `w` field within this structure.
- **removed ID from all method declarations.** IDs are only ever
automatically assigned now. Fixes #3068.
- added an `:overlay` parameter to method declarations, in order to
declare a new method that goes on top of a previously-defined method.
Syntax is `:overlay <method-name>`. Please do not ever use this.
- added `state-methods` list parameter. This lets you quickly specify a
list of states to be put in the method table. Same syntax as the
`states` list parameter. The decompiler will try to put as many states
in this as it can without messing with the method ID order.

Also changes `defmethod` to make the first type definition (before the
arguments) optional. The type can now be inferred from the first
argument. Fixes #3093.

---------

Co-authored-by: Hat Kid <6624576+Hat-Kid@users.noreply.github.com>
2023-10-30 03:20:02 +00:00

176 lines
4.8 KiB
Common Lisp

;;-*-Lisp-*-
(in-package goal)
;; name: entity-h.gc
;; name in dgo: entity-h
;; dgos: GAME, ENGINE
(defun-extern entity-by-name string entity)
(defun-extern entity-by-type type entity-actor)
(defun-extern entity-by-aid uint entity)
(define-extern reset-actors (function symbol none))
(define-extern *spawn-actors* symbol)
;; TODO - for cam-start
(define-extern reset-cameras (function none))
(define-extern process-by-ename (function string process))
(define-extern entity-birth-no-kill (function entity none))
;; DECOMP BEGINS
(define *generate-actor-vis* #f)
(define *generate-actor-vis-start* #f)
(define *generate-actor-vis-output* #f)
(deftype entity-perm (structure)
((user-object object 2)
(user-uint64 uint64 :overlay-at (-> user-object 0))
(user-float float 2 :overlay-at (-> user-object 0))
(user-int32 int32 2 :overlay-at (-> user-object 0))
(user-uint32 uint32 2 :overlay-at (-> user-object 0))
(user-int16 int16 4 :overlay-at (-> user-object 0))
(user-uint16 uint16 4 :overlay-at (-> user-object 0))
(user-int8 int8 8 :overlay-at (-> user-object 0))
(user-uint8 uint8 8 :overlay-at (-> user-object 0))
(status entity-perm-status)
(dummy uint8 1)
(task game-task)
(aid actor-id)
(quad uint128 :overlay-at (-> user-object 0))
)
:pack-me
(:methods
(update-perm! (_type_ symbol entity-perm-status) _type_)
)
)
(deftype entity-links (structure)
((prev-link entity-links)
(next-link entity-links)
(entity entity)
(process process)
(level level)
(vis-id int32)
(trans vector :inline)
(perm entity-perm :inline)
(status uint16 :overlay-at (-> perm status))
(aid actor-id :overlay-at (-> perm aid))
(task game-task :overlay-at (-> perm task))
)
(:methods
(birth? (_type_ vector) symbol)
)
)
(deftype entity-perm-array (inline-array-class)
((data entity-perm :inline :dynamic)
)
)
(set! (-> entity-perm-array heap-base) (the-as uint 16))
(deftype entity-links-array (inline-array-class)
((data entity-links :inline :dynamic)
)
)
(set! (-> entity-links-array heap-base) (the-as uint 64))
(deftype entity (res-lump)
((trans vector :inline)
(aid uint32)
)
(:methods
(birth! (_type_) _type_)
(kill! (_type_) _type_)
(add-to-level! (_type_ level-group level actor-id) none)
(remove-from-level! (_type_ level-group) _type_)
(get-level (_type_) level)
)
)
(deftype entity-camera (entity)
((connect connectable :inline)
)
)
(deftype entity-ambient-data (structure)
((user-object object 3)
(function (function drawable-ambient vector none))
(quad uint128 :overlay-at (-> user-object 0))
(user-uint64 uint64 1 :overlay-at (-> user-object 0))
(user-float float 3 :overlay-at (-> user-object 0))
(user-int32 int32 3 :overlay-at (-> user-object 0))
(user-uint32 uint32 3 :overlay-at (-> user-object 0))
(user-int16 int16 6 :overlay-at (-> user-object 0))
(user-uint16 uint16 6 :overlay-at (-> user-object 0))
(user-int8 int8 12 :overlay-at (-> user-object 0))
(user-uint8 uint8 12 :overlay-at (-> user-object 0))
)
)
(deftype entity-ambient-data-array (inline-array-class)
((data entity-ambient-data :inline :dynamic)
)
)
(set! (-> entity-ambient-data-array heap-base) (the-as uint 16))
(deftype entity-ambient (entity)
((ambient-data entity-ambient-data :overlay-at extra)
)
(:methods
(draw-debug (_type_) none)
(birth-ambient! (_type_) none)
)
)
(deftype entity-actor (entity)
((nav-mesh nav-mesh)
(etype type)
(task game-task)
(vis-id uint16)
(vis-id-signed int16 :overlay-at vis-id)
(quat quaternion :inline)
)
(:methods
(next-actor (_type_) entity-actor)
(prev-actor (_type_) entity-actor)
(debug-print (_type_ symbol type) none)
(set-or-clear-status! (_type_ entity-perm-status symbol) none)
)
)
(deftype entity-info (basic)
((ptype type)
(package basic)
(art-group pair)
(pool basic)
(heap-size int32)
)
)
;; NOTE - this is a strange pattern...this symbol isn't defined until a later file 'navigate'
;; But this seems to be setting the symbol to nothing if it's not found, but of course, our compiler freaks out
(define-extern entity-nav-login (function entity-actor none))
(if (zero? entity-nav-login)
(set! entity-nav-login (the-as (function entity-actor none) nothing))
)
(deftype actor-bank (basic)
((pause-dist float)
(birth-dist float)
(birth-max int32)
)
)
(define *ACTOR-bank* (new 'static 'actor-bank :pause-dist (meters 50) :birth-dist (meters 220) :birth-max 10))