Actors - Revision history

Mzxrules at 17:47, 6 August 2021

2021-08-06T17:47:32Z

Nokaubure: /* Actor Instances */

2019-05-26T18:00:22Z

‎Actor Instances

Nokaubure: /* Actor Instances */

2019-05-26T17:56:14Z

‎Actor Instances

Mzxrules: /* Actor Instances */

2018-10-25T05:21:48Z

‎Actor Instances

Mzxrules: /* Loading Actors */

2016-06-05T18:45:49Z

‎Loading Actors

Mzxrules at 18:42, 5 June 2016

2016-06-05T18:42:11Z

Mzxrules at 01:24, 23 December 2014

2014-12-23T01:24:03Z

Mzxrules at 03:58, 19 June 2014

2014-06-19T03:58:56Z

Mzxrules: Created page with "{{:oot:Actors}}"

2014-06-18T04:15:36Z

Created page with "{{:oot:Actors}}"

New page

@@ Line 72: / Line 72: @@
      /* 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 + ????
+     /* 0x1E */ s8       objTableIndex; //index to the Object Table at Game Play + ????
      /* 0x1F */ u8       unk_0x01F;
      /* 0x20 */ u16      soundEffect; //Plays sound effect relative to actor's location (if within range of camera?)
@@ Line 195: / Line 195: @@
 ***Whatever else that actor needs (ex. instanced variables).
-At [[Global Context]] + 0x1CB0 is a list of actor categories (see above), each element structured as follows:
+At [[Game Play]] + 0x1CB0 is a list of actor categories (see above), each element structured as follows:
   int numOfActors;

@@ Line 65: / Line 65: @@
      /* 0x03 */ u8       room; //Room number the actor is part of. FF denotes that the actor won't despawn on a room change
      /* 0x04 */ s32      flags; //flags used for drawing stuff?
-     // & 0x0040 0000 = Affects actor lighting. 0 passes current coords to 80066298 func, else pass null for coords
+     // & 0x0040 0000 = Affects actor lighting
      // & 0x0000 1000 = ?
      // & 0x0000 0040 = ?
@@ Line 72: / Line 72: @@
      /* 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 Global Context + ????
      /* 0x1F */ u8       unk_0x01F;
      /* 0x20 */ u16      soundEffect; //Plays sound effect relative to actor's location (if within range of camera?)

@@ Line 61: / Line 61: @@
 typedef struct
+{
-     /* 0x00 */ u16      id;
+     /* 0x00 */ u16      id; //Actor Id.
-     /* 0x02 */ u8       type;
+     /* 0x02 */ u8       type; //Actor Type. See Below
      /* 0x03 */ u8       room; //Room number the actor is part of. FF denotes that the actor won't despawn on a room change
-     /* 0x04 */ s32      flags;
+     /* 0x04 */ s32      flags; //flags used for drawing stuff?
-     /* 0x08 */ Coord    Pos1; //Related to collision detection routine
+    // & 0x0040 0000 = Affects actor lighting. 0 passes current coords to 80066298 func, else pass null for coords
-     /* 0x14 */ rotation initRot;
+    // & 0x0000 1000 = ?
      /* 0x1A */ u16      unk_0x01A;
-     /* 0x1C */ u16      variable;
+     /* 0x1C */ u16      variable; //Configurable variable set by an actor's spawn data
-     /* 0x1E */ u16      unk_0x01E;
+     /* 0x1E */ s8       objTableIndex; //index to table at Global Context + 0x117A4
-     /* 0x20 */ u16      soundEffect; //Plays sound effect (relative to actor's location, if within range of camera?)
+    /* 0x1F */ u8       unk_0x01F;
      /* 0x22 */ u16      unk_0x022;
-     /* 0x24 */ Coord    Pos2; //Current coordinate
+     /* 0x24 */ Coord_f  position; //Current coordinates
-     /* 0x30 */ u16      unk_0x030;
+     /* 0x30 */ Rotation speedRot; //0x32 sets what direction the 0x68 speedXZ variable is moving the actor
-     /* 0x32 */ u16      unk_0x032;
+     /* 0x36 */ u16      unk; //same as 0x1A
-     /* 0x34 */ char     buff[4];
+     /* 0x38 */ int8     unk;
-     /* 0x38 */ Coord    Pos3;
+     /* 0x39 */ uint8    unk;
-     /* 0x44 */ rotation rot_1;
+    /* 0x3A */ u16      unk;
-     /* 0x4A */ u16      unk_0x04A;
+     /* 0x3C */ Coord_f  pos3; //Related to camera
-     /* 0x4C */ f32      unk_0x04C; /* I know this is a float from breakpointing it */
+    /* 0x48 */ Rotation rot1; //0x30 rotation copied into here
-     /* 0x50 */ Coord    Scale;
+     /* 0x4E */ u16      unk;
-     /* 0x5C */ char     buff2[0x54];
+     /* 0x50 */ int32    unk;

@@ Line 40: / Line 40: @@
 ==Actor Instances==
 <syntaxhighlight lang="c">typedef struct {
@@ Line 49: / Line 48: @@
 	u16 x, y, z;
 } rotation;
 typedef struct
+{
-     /* !0x00 */ u16 actorNo;
+     /* 0x00 */ u16      id;
-     /* !0x02 */ u8 actorType;
+     /* 0x02 */ u8       type;
-     /* !0x03 */ u8 roomNo; //Room number the actor is part of. FF denotes that the actor won't despawn on a room change
+     /* 0x03 */ u8       room; //Room number the actor is part of. FF denotes that the actor won't despawn on a room change
-     /* 0x04 */ u32 unk_01;
+     /* 0x04 */ s32      flags;
-     /* !0x08 */ Coord Pos1; //Related to collision detection routine
+     /* 0x08 */ Coord    Pos1; //Related to collision detection routine
-     /* !0x14 */ rotation initRot;
+     /* 0x14 */ rotation initRot;
-     /* 0x1A */ u16 unk_02;
+     /* 0x1A */ u16      unk_0x01A;
-     /* !0x1C */ u16 actorVariable;
+     /* 0x1C */ u16      variable;
-     /* 0x1E */ u16 unk_03;
+     /* 0x1E */ u16      unk_0x01E;
-     /* 0x20 */ u16 soundEffect; //Plays sound effect (relative to actor's location, if within range of camera?)
+     /* 0x20 */ u16      soundEffect; //Plays sound effect (relative to actor's location, if within range of camera?)
-     /* 0x22 */ u16 unk_04;
+     /* 0x22 */ u16      unk_0x022;
-     /* 0x24 */ Coord Pos2; //Current coordinate
+     /* 0x24 */ Coord    Pos2; //Current coordinate
-     /* 0x30 */ u16 unk_04_a;
+     /* 0x30 */ u16      unk_0x030;
-     /* 0x32 */ u16 unk_04_b;
+     /* 0x32 */ u16      unk_0x032;
-     /* 0x34 */ char buff[4];
+     /* 0x34 */ char     buff[4];
-     /* 0x38 */ Coord Pos3;
+     /* 0x38 */ Coord    Pos3;
      /* 0x44 */ rotation rot_1;
-     /* 0x4A */ u16 unk_05;
+     /* 0x4A */ u16      unk_0x04A;
-     /* 0x4C */ f32 unk_06; /* I know this is a float from breakpointing it */
+     /* 0x4C */ f32      unk_0x04C; /* I know this is a float from breakpointing it */
-     /* 0x50 */ Coord Scale;
+     /* 0x50 */ Coord    Scale;
-     /* 0x5C */ char buff2[0x58];
+     /* 0x5C */ char     buff2[0x54];
-     /* !0xBC */ rotation rot_2; //Setting this immediately changes actor's rotation
      /* ? */ char buff3[0x66];
      /* 0x115 */ u8 runActor; // Determines if actor instance should be processed. 01 for yes, 00 for no.
-     /* !0x128 */ z_ram_actor* actor_prev; /* Previous z_ram_actor of this type */
+     /* 0x128 */ struct z2_Actor* actor_prev; /* Previous z_ram_actor of this type */
-     /* !0x12C */ z_ram_actor* actor_next; /* Next z_ram_actor of this type */
+     /* 0x12C */ struct z2_Actor* actor_next; /* Next z_ram_actor of this type */
-     /* ? */ u32 unk; //Actor Constructor?
+     /* 0x130 */ void*   Init; //Actor Constructor?
-     /* ? */ u32 ActorInit; //Actor Deconstructor?
+     /* 0x134 */ void*   Dest; //Actor Deconstructor?
-     /* ? */ u32 ActorDraw;
+     /* 0x138 */ void*   Main;
-     /* ? */ u32 ActorMain;
+     /* 0x13C */ void*   Draw;
-     /* ? */ u32 CodeEntry; //Address to source overlay file's reference in code (file)
+     /* 0x140 */ void*   CodeEntry; //Address to source overlay file's reference in code (file)
      /* ? */
      /* From here on, the structure and size varies for each actor */
-} z_ram_actor;
+} z2_Actor;
 </syntaxhighlight>

@@ Line 156: / Line 156: @@
 ***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 [[Global Context]] + 0x1CB0 is a list of actor categories (see above), each element structured as follows:
 ==Custom Actors==

← Older revision		Revision as of 18:42, 5 June 2016
Line 1:		Line 1:
	{{article link\|Actors}}		{{article link\|Actors}}
		+
		+	{{See also\|Category:Actors}}
		+
		+	Actors are the various interactive pieces in the Zelda 64 engine, from enemies to static scenery.
		+	__TOC__
		+	{{clear}}
		+	There are three major components to an actor:
		+	* The actor's [[overlay]], a file that contains the code for an actor
		+	* Actor instances, or an in memory representation of our actor.
		+	* [[Object\|Object files]], one or more files that contain pre-generated microcode, animations, and graphical assets for an actor. These can be shared by multiple actors.
		+
		+	== Actor Overlay Table ==
		+	{{:Actor Overlay Table}}
		+
		+	== Overlay File ==
		+	See [[Overlays]] for more information on the overlay format.
		+
		+	=== Initialization Variables ===
		+	The actor's initialization variables are pointed to via the 6th word in the Actor Overlay Table.
		+
		+	<syntaxhighlight lang="csharp">
		+	/0x00/ short ActorNumber //value does not always match the instance's real actor number
		+	/0x02/ byte ActorType //See Below
		+	/0x03/ byte RoomNumber //Room instance was spawned in. If value set to FF in rom, instance does not despawn when swapping rooms
		+
		+	//0x04 is unknown
		+	/0x08/ short ObjectNumber //possibly it's primary object dependency
		+	//0x0A Padding
		+
		+	/0x0C/ int InstanceSize
		+	/0x10/ int* ?
		+	/0x14/ int* Deconstructor
		+	/0x18/ int* ?
		+	/0x1C/ int* ?
		+	</syntaxhighlight>
		+
		+	=== Common Data Structures ===
		+	* [[Collision (Actors)]]
		+
		+	==Actor Instances==
		+	{{fix\|confirm elements in structure are accurate for Majora's Mask. ! marks confirmed}}
		+
		+	<syntaxhighlight lang="c">typedef struct {
		+	f32 x, y, z;
		+	} Coord;
		+
		+	typedef struct {
		+	u16 x, y, z;
		+	} rotation;
		+
		+	typedef struct
		+	{
		+	/* !0x00 */ u16 actorNo;
		+	/* !0x02 */ u8 actorType;
		+	/* !0x03 */ u8 roomNo; //Room number the actor is part of. FF denotes that the actor won't despawn on a room change
		+	/* 0x04 */ u32 unk_01;
		+	/* !0x08 */ Coord Pos1; //Related to collision detection routine
		+	/* !0x14 */ rotation initRot;
		+	/* 0x1A */ u16 unk_02;
		+	/* !0x1C */ u16 actorVariable;
		+	/* 0x1E */ u16 unk_03;
		+	/* 0x20 */ u16 soundEffect; //Plays sound effect (relative to actor's location, if within range of camera?)
		+	/* 0x22 */ u16 unk_04;
		+	/* 0x24 */ Coord Pos2; //Current coordinate
		+	/* 0x30 */ u16 unk_04_a;
		+	/* 0x32 */ u16 unk_04_b;
		+	/* 0x34 */ char buff[4];
		+	/* 0x38 */ Coord Pos3;
		+	/* 0x44 */ rotation rot_1;
		+	/* 0x4A */ u16 unk_05;
		+	/* 0x4C / f32 unk_06; / I know this is a float from breakpointing it */
		+	/* 0x50 */ Coord Scale;
		+	/* 0x5C */ char buff2[0x58];
		+	/* !0xBC */ rotation rot_2; //Setting this immediately changes actor's rotation
		+	/* ? */ char buff3[0x66];
		+	/* 0x115 */ u8 runActor; // Determines if actor instance should be processed. 01 for yes, 00 for no.
		+	/* !0x128 / z_ram_actor actor_prev; /* Previous z_ram_actor of this type */
		+	/* !0x12C / z_ram_actor actor_next; /* Next z_ram_actor of this type */
		+	/* ? */ u32 unk; //Actor Constructor?
		+	/* ? */ u32 ActorInit; //Actor Deconstructor?
		+	/* ? */ u32 ActorDraw;
		+	/* ? */ u32 ActorMain;
		+	/* ? */ u32 CodeEntry; //Address to source overlay file's reference in code (file)
		+	/* ? */
		+	/* From here on, the structure and size varies for each actor */
		+	} z_ram_actor;
		+
		+	/* 8-10-2012 : Addition made by Jason777 */
		+	/* For actors which contain a damage chart (example: Stalfos)... */
		+	typedef struct
		+	{
		+	..
		+	/* !0xA0 / u32 DamageChart; / Pointer to the actor's Damage Chart in RAM. */
		+	..
		+	/* !0xB7 */ u8 Health; //probably actually a short
		+	/* ?0xB9 */ u8 DamageEffect; //Stores what effect should occur when hit by a weapon
		+	..
		+	} z_ram_actor;
		+	</syntaxhighlight>
		+
		+	=== Categories ===
		+	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",
		+	"NPC", "Enemy", "Prop (2)", "Item/Action",
		+	"Misc", "Boss", "Door", "Chests"
		+	};
		+	{\|class="wikitable"
		+	! Id
		+	! Description
		+	! Usage
		+	\|-
		+	\|0 \|\| Switches \|\| Step-on switches, Anubis enemy, Death Mountain Crater Smoke Cone
		+	\|-
		+	\|1 \|\| Prop (1) \|\| Typically larger, more complex set pieces
		+	\|-
		+	\|2 \|\| Player \|\|
		+	\|-
		+	\|3 \|\| Bomb \|\| Bombs, Bombchus
		+	\|-
		+	\|4 \|\| NPC \|\|
		+	\|-
		+	\|5 \|\| Enemy \|\| Used for triggering room clear state.
		+	\|-
		+	\|6 \|\| Prop \|\|
		+	\|-
		+	\|7 \|\| Item/Action \|\|
		+	\|-
		+	\|8 \|\| Misc \|\|
		+	\|-
		+	\|9 \|\| Boss \|\|
		+	\|-
		+	\|10 \|\| Door \|\|
		+	\|-
		+	\|11 \|\| Chests \|\|
		+	\|}
		+
		+	==Loading Actors==
		+	What is currently known about the loading and execution of code from actors in Zelda 64 is that:<br>
		+	*The first time an actor is loaded ([[Ram Map (Debug Rom)#ActorSpawn\|spawned]]), its overlay file is transferred to RAM
		+	**The transferred file has its offsets relocated to a real address space in RAM
		+	**The actor file remains allocated in ram until all instances of that actor have despawned
		+	*The game begins to create an instance of the actor
		+	*For each actor instance, actors are given a certain amount of memory as defined in the actor file. However, the minimum space required by the game's engine is 0x128 bytes in OoT (MM may vary).
		+	**Within this given memory is information such as
		+	***Location
		+	***Rotation
		+	***Scale
		+	***Pointer to damage chart (if the actor has one)
		+	***Pointers to actor functions
		+	****Initialization - run when actor instance is loaded.
		+	****Main - always run during gameplay.
		+	****Drawing - to be run when actor is close enough to the camera.
		+	***Pointer to Next/Previous actor(s) of this actor's category
		+	***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.
		+
		+	==Custom Actors==
		+	A number of custom actors have been created. For more information, see [[Overlays]].
		+
		+	==Examples==
		+	[http://spinout182.com/mqd/a.html Every actor in Debug MQ disassembled]
		+
		+	==Credits==
		+	Cendamos - Actor table information, misc stuff that got the ball rolling<br>
		+	Euler - Actor file structure<br>
		+	JayTheHam - His early work with Cendamos on actor information<br>
		+	ZZT32 - Explained some actor table stuff to me<br>
		+	spinout - Writing this article
		+	[[Category: Actors\| ]]
		+	[[Category: File Formats]]

← Older revision		Revision as of 01:24, 23 December 2014
Line 1:		Line 1:
−	~~See [[:oot:~~Actors]]	+	{{article link\|Actors}}

← Older revision		Revision as of 03:58, 19 June 2014
Line 1:		Line 1:
−	{{:oot:Actors}}	+	See [[:oot:Actors]]