Actors - Revision history

Mzxrules at 16:09, 6 August 2021

2021-08-06T16:09:59Z

Mzxrules: /* Initialization Variables */ oops

2020-04-05T17:42:46Z

‎Initialization Variables: oops

Nokaubure: /* Initialization Variables */

2019-12-05T14:30:34Z

‎Initialization Variables

Nokaubure: /* Initialization Variables */

2019-12-05T10:31:52Z

‎Initialization Variables

Nokaubure: improved damage color effect

2019-12-03T22:33:08Z

improved damage color effect

Nokaubure: /* Initialization Variables */

2019-11-30T12:39:49Z

‎Initialization Variables

Nokaubure: /* Structure */

2019-04-13T15:28:40Z

‎Structure

Mzxrules: /* Categories */

2018-12-19T17:15:25Z

‎Categories

Nokaubure: /* Initialization Variables */

2018-12-10T22:50:50Z

‎Initialization Variables

Mzxrules: /* Structure */

2018-08-04T16:14:44Z

‎Structure

@@ Line 87: / Line 87: @@
      /* 0x1A */ u16      unk_0x01A;
      /* 0x1C */ u16      variable; //Configurable variable set by an actor's spawn data
-     /* 0x1E */ s8       objTableIndex; //index to table at Global Context + 0x117A4
+     /* 0x1E */ s8       objTableIndex; //index to table at Game Play + 0x117A4
      /* 0x1F */ u8       unk_0x01F;
      /* 0x20 */ u16      soundEffect; //Plays sound effect relative to actor's location (if within range of camera?)
@@ Line 147: / Line 147: @@
      /* 0xD8 */ Coord_f  unk_0x0D8; //used in Link, not Deku Babas
      /* 0xE4 */ Coord_f  unk_0x0E4; //stores result of some vector transformation involving
-                         // actor xyz vector, and a matrix at Global Context + 11D60
+                         // actor xyz vector, and a matrix at Game Play + 11D60
      /* 0xF0 */ float    unk_0x0F0; //related to above
      /* 0xF4 */ float    unk_0x0F4; //unknown
@@ Line 185: / Line 185: @@
 //ActorMain, Actor Draw arguments
 //A0 = Actor Instance
-//A1 = Global Context
+//A1 = Game Play
 </syntaxhighlight>
@@ Line 254: / Line 254: @@
 ***Whatever else that actor needs (ex. instanced variables).
-At [[Global Context]] + 0x1C30 (80213C50 in the Debug Rom's RAM) is a list of actor categories (see above), each entry being an integer and a pointer. The pointer points to the first allocated entry for an actor. The integer is the number of actors of that category, the first entry being type 0, and the last last being type 11 (chests). Actors after the first actor are pointed to through the next/previous pointers within each allocated actor.
+At [[Game Play]] + 0x1C30 (80213C50 in the Debug Rom's RAM) is a list of actor categories (see above), each entry being an integer and a pointer. The pointer points to the first allocated entry for an actor. The integer is the number of actors of that category, the first entry being type 0, and the last last being type 11 (chests). Actors after the first actor are pointed to through the next/previous pointers within each allocated actor.
 === Compact Instance Initialization Format ===

@@ Line 23: / Line 23: @@
      /* 0x00 */ s16 Id; //value does not always match the instance's real actor number
      /* 0x02 */ u8  Type; //classifies actor and determines when actor will execute
      /* 0x04 */ s32 Flags; //unknown, but seems to have an effect on the ability to Z-Target an actor.

@@ Line 45: / Line 45: @@
 * & 0x0000 0400 - hookshotable (collider + 0x1D has to be set to 05)
 * & 0x0040 0000 = Affects actor lighting. 0 passes current coords to 80066298 func, else pass null for coords
 * & 0x0400 0000 = Actor is able to press floor switches
 * & 0x0000 1000 = ?

@@ Line 43: / Line 43: @@
 * & 0x0000 0020 - draw function always run regardless if the camera is not focusing at the actor
 * & 0x0000 0040 - programmatically computed (?)
 * & 0x0040 0000 = Affects actor lighting. 0 passes current coords to 80066298 func, else pass null for coords
 * & 0x0400 0000 = Actor is able to press floor switches

@@ Line 156: / Line 156: @@
      /* 0x10E */ u16     textId; //text id to pass to link/display when interacting with an actor (navi text, probably others)
      /* 0x110 */ s16     freezeActor; //Used for the "Redead Freeze" attack
-     /* 0x112 */ s16     unk_0x112; //Damage color effect, first 12 bits controls color which can only be blue red and white, last 4 bits unknown, can't be 0
+     /* 0x112 */ u8     unk_0x112; //Damage color effect, the higher the number the higher the color intensity, 00-1F = blue, 40-5F = red, 80-9F = white, C0-DF = white (duplicate)
      /* 0x114 */ u8      unk_0x114; //Damage color effect timer, decremented toward 0 every frame
      /* 0x115 */ u8      runActor; // Determines if actor instance should be processed. 01 for yes, 00 for no.

@@ Line 198: / Line 198: @@
 Actor instances are added into a doubly-linked list based on a category id. Ids can be set in the overlay file, but can also be pro grammatically modified (ex. Skulltula/Gold Skulltula actor). There are 12 categories total. Majora's Mask may use 16 different categories.
   char * actor_types[12] = {
-      "Switch",	"Prop (1)",	"Player",	"Bomb",
+      "Switch",  "Backgrounds",  "Player",       "Bomb",
-      "NPC",	"Enemy",	"Prop (2)",	"Item/Action",
+      "NPC",     "Enemy",        "Prop (2)",     "Item/Action",
-      "Misc",	"Boss",		"Door",		"Chests"
+      "Misc",    "Boss",         "Door",         "Chests"
   };
 {|class="wikitable"
@@ Line 209: / Line 209: @@
 |0 || Switches || Step-on switches, Anubis enemy, Death Mountain Crater Smoke Cone
 |-
-|1 || Prop (1) || Typically larger, more complex set pieces
+|1 || Backgrounds || Typically larger, more complex set pieces with background collision
 |-
 |2 || Player ||

@@ Line 38: / Line 38: @@
 Some notes on the "Flags" variable:
 * & 0x0040 0000 = Affects actor lighting. 0 passes current coords to 80066298 func, else pass null for coords
 * & 0x0000 1000 = ?
 * If it's set to 0x10, the actor seems to not be targetable when initialized.
 * If it's set to 0x9, it is targetable.

@@ Line 108: / Line 108: @@
      /* 0x8A */ s16      unk_roty; //rotation y (give item, possibly next facing dir?/face toward link?)
      /* 0x8C */ float    unk_0x08C;
-     /* 0x90 */ float    xzDistanceFromLink; // (item giving routine)
+     /* 0x90 */ float    xzDistanceFromLink;
-     /* 0x94 */ float    yDistanceFromLink; //related to above
+     /* 0x94 */ float    yDistanceFromLink; // relative distance
      /* 8-10-2012 : Addition made by Jason777 */
      /* For actors which contain a damage chart (example: Stalfos)... */
@@ Line 115: / Line 115: @@
+     {
      /* 0x98 */ z_ActorDamageTable* DamageChart;  /* Pointer to the actor's Damage Chart in RAM. */
-     /* 0x9C */ Coord_f  velocity2; //secondary x,y,z vector for positioning (probably platform actors), added to 0x5C vector
+     /* 0x9C */ Coord_f  displacement; //amount to correct velocity (0x5C) by when colliding into a body
      /* 0xA8 */ s16      unk_0x0A8;
      /* 0xAA */ s16      unk_0x0AA;
      /* 0xAC */ u16      unk_0x0AC; //unk
-     /* 0xAE */ u8       unkn_00AE; // Collision related?, Set to 0xFD by bottled blue fire
+     /* 0xAE */ u8       mass; // Used to compute displacement, 50 is common value, 0xFF for infinite mass/unmoveable
-     /* 0xAF */ u8       Health;
+     /* 0xAF */ u8       health;
-     /* 0xB0 */ u8       Damage; //amount to decrement health by
+     /* 0xB0 */ u8       damage; //amount to decrement health by
-     /* 0xB1 */ u8       DamageEffect; //Stores what effect should occur when hit by a weapon
+     /* 0xB1 */ u8       damageEffect; //Stores what effect should occur when hit by a weapon
-     /* 0xB2 */ u8       ImpactEffect; //Maybe? set on deku nut when deku nut collides with gossip stone
+     /* 0xB2 */ u8       impactEffect; //Maybe? set on deku nut when deku nut collides with gossip stone
      /* 0xB3 */ u8       unk_0x0B3; //?
-     }; /* end damage chart data */
+     }; //CollisionCheck common
      struct
@@ Line 162: / Line 162: @@
      //     Volvagia Hole stores Volvagia Flying here
-     /* 0x11C */ struct z_Actor* attachedB; //Attached to Actor
+     /* 0x11C */ struct z_Actor* attachedB; //Attached to Actor (
 	//e.g. Link holding chu, Link instance stores ptr to Bombchu instance here
      /* 0x120 */ struct z_Actor* actor_prev; /* Previous z_Actor of this type */
@@ Line 174: / Line 174: @@
 } z_Actor;
 //actors with a poly-type collision mesh will always set this variable
-    /* 0x13C */ s32 PolyActorId; //Index for poly mesh
+//    /* 0x13C */ s32 PolyActorId; //Index for poly mesh
 </syntaxhighlight>