User:Deldee/objectAnatomyDraft - Revision history

Deldee at 16:40, 11 October 2023

2023-10-11T16:40:58Z

← Older revision		Revision as of 16:40, 11 October 2023
Line 4:		Line 4:
	==Anatomy of an Object Code==		==Anatomy of an Object Code==
	===Initialization===		===Initialization===
	To start the object initialization, the object is called via a Macro preset~~<ref>[https://github.com/n64decomp/sm64/blob/master/include/macro_presets.inc.c#L47 Goomba Macro Preset]</ref>~~ from the level script, which will prompt it initialization with the attached BehaviorScript. The BehaviorScript is then fetched in [https://github.com/n64decomp/sm64/blob/master/data/behavior_data.c data/behavior_data.c] to start initializaing the object.<br>		To start the object initialization, the object is called via a Macro preset from the level script, which will prompt it initialization with the attached BehaviorScript. The BehaviorScript is then fetched in [https://github.com/n64decomp/sm64/blob/master/data/behavior_data.c data/behavior_data.c] to start initializaing the object.<br>
	''Note : The following order is not consistent over the whole code. The collision data for example is loaded at different point depending on the BehaviorScript in question.		''Note : The following order is not consistent over the whole code. The collision data for example is loaded at different point depending on the BehaviorScript in question.
	===Set Object List===		===Set Object List===
Line 19:		Line 19:
	===Set Object Specific Values===		===Set Object Specific Values===
	Set object specific values (Home, physic, drop to floor) - > [https://github.com/n64decomp/sm64/blob/master/src/engine/behavior_script.c src/engine/behavior_script.c] <br>		Set object specific values (Home, physic, drop to floor) - > [https://github.com/n64decomp/sm64/blob/master/src/engine/behavior_script.c src/engine/behavior_script.c] <br>
			For all object, multiple extra operation can and will be done, of which an exhaustive list can be found in [https://github.com/n64decomp/sm64/blob/master/src/engine/behavior_script.c src/engine/behavior_script.c]. The operation done for the Goomba BehaviorScript are:
			* Set the object's physics
			* Set the object's home
			* Drop the object to the floor

			===Call the Object-specific gameloop behavior===
	~~Call Native Behavior (init~~ behavior~~) - >~~ [https://github.com/n64decomp/sm64/tree/master/src/game/behaviors ~~Behavior Lists~~]~~<br>~~		There are two typically two types of behavior functions located in the behavior file of an object, which are located in [https://github.com/n64decomp/sm64/tree/master/src/game/behaviors src/game/behaviors]. The "initialization" function, which is typically run once when loading the objects. The "loop" function, on the other hand, is the behavior that will run on every processing frames. The main way to distinguish between them is that the latter is surrounded by "BEGIN_LOOP()" and "END_LOOP()" and always comes at the end of the BehaviorScript.
	* This will also set the hitbox, which is ~~usually a struct defined in~~ the ~~same file~~, ~~but can be different files~~ (~~boulder for example~~)~~<br>~~
	~~Begin Behavior Loop<br>~~
	* Call loop behavior - > [https://github.~~com/n64decomp/sm64/tree/master/src/game/behaviors Behavior Lists]<br>~~
	~~End Loop~~

Deldee: started the draft of object anatomy

2023-10-11T15:48:09Z

started the draft of object anatomy

← Older revision		Revision as of 15:48, 11 October 2023
Line 2:		Line 2:

	Rough draft, using goomba as an example: <br>		Rough draft, using goomba as an example: <br>
	~~Init -~~ > [https://github.com/n64decomp/sm64/blob/master/data/behavior_data.c data/behavior_data.c]<br>		==Anatomy of an Object Code==
	Set ~~OBJ_LIST - >~~ [[Objects#Object_Groups\|Object Groups]]~~<br>~~		===Initialization===
	Set ~~OBJ~~ Flag ~~- > Nothing <br>~~		To start the object initialization, the object is called via a Macro preset<ref>[https://github.com/n64decomp/sm64/blob/master/include/macro_presets.inc.c#L47 Goomba Macro Preset]</ref> from the level script, which will prompt it initialization with the attached BehaviorScript. The BehaviorScript is then fetched in [https://github.com/n64decomp/sm64/blob/master/data/behavior_data.c data/behavior_data.c] to start initializaing the object.<br>
	Load animation or ~~Model - >~~ [~~[Actor groups~~]~~] and~~ [https://github.com/n64decomp/sm64/tree/master/actors ~~Actors list~~] ~~<br>~~		''Note : The following order is not consistent over the whole code. The collision data for example is loaded at different point depending on the BehaviorScript in question.
	Set object specific values (Home, physic, drop to floor) - > ~~TODO~~ <br>		===Set Object List===
			The first action of any BehaviorScript is to set the Object List (Or [[Objects#Object_Groups\|Object Groups]]) of an object, this categorizes the object in their processing order

			===Set Collision data===
			Scripts of the "SURFACE" object group will load their collision data. This collision data is fetched from the level structure. For example, here is the [https://github.com/n64decomp/sm64/blob/master/levels/jrb/falling_pillar_base/collision.inc.c#L2 Falling Pillar collision data].
			===Set Object Flag===
			Another early action is to set the object flags of the object, these typically represent value to constantly take into account at every processing frame or high level operations to execute. For a Goomba, those are OBJ_FLAG_COMPUTE_ANGLE_TO_MARIO, OBJ_FLAG_COMPUTE_DIST_TO_MARIO, OBJ_FLAG_SET_FACE_YAW_TO_MOVE_YAW, OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE. This means that, every frame, the Goomba's Angle to Mario and Distance to Mario will be calculated and that its Yaw and graphical data will be updated

			===Load Animation or Model===
			For objects that are not part of the "SURFACE" group, the animation or model will be loaded. Animations are located in the subfolder of the object in the [https://github.com/n64decomp/sm64/tree/master/actors Actors list]. As an example, for a Goomba, the animation data is located at [https://github.com/n64decomp/sm64/tree/master/actors/goomba/anims /actors/goomba/anims]

			===Set Object Specific Values===
			Set object specific values (Home, physic, drop to floor) - > [https://github.com/n64decomp/sm64/blob/master/src/engine/behavior_script.c src/engine/behavior_script.c] <br>


	Call Native Behavior (init behavior) - > [https://github.com/n64decomp/sm64/tree/master/src/game/behaviors Behavior Lists]<br>		Call Native Behavior (init behavior) - > [https://github.com/n64decomp/sm64/tree/master/src/game/behaviors Behavior Lists]<br>
	* This will also set the hitbox, which is usually a struct defined in the same file, but can be different files (boulder for example)<br>		* This will also set the hitbox, which is usually a struct defined in the same file, but can be different files (boulder for example)<br>

Deldee: Created page with "The following is a draft a full article on the object processes, to help debugging them for newcomers : Rough draft, using goomba as an example:
Init - > [https://githu..."

2023-10-11T14:37:29Z

Created page with "The following is a draft a full article on the object processes, to help debugging them for newcomers : Rough draft, using goomba as an example: Init - > [https://githu..."

New page

The following is a draft a full article on the object processes, to help debugging them for newcomers :

Rough draft, using goomba as an example: 
Init - > [https://github.com/n64decomp/sm64/blob/master/data/behavior_data.c data/behavior_data.c] 
Set OBJ_LIST - > [[Objects#Object_Groups|Object Groups]] 
Set OBJ Flag - > Nothing 
Load animation or Model - > [[Actor groups]] and [https://github.com/n64decomp/sm64/tree/master/actors Actors list] 
Set object specific values (Home, physic, drop to floor) - > TODO 
Call Native Behavior (init behavior) - > [https://github.com/n64decomp/sm64/tree/master/src/game/behaviors Behavior Lists] 
* This will also set the hitbox, which is usually a struct defined in the same file, but can be different files (boulder for example) 
Begin Behavior Loop 
* Call loop behavior - > [https://github.com/n64decomp/sm64/tree/master/src/game/behaviors Behavior Lists] 
End Loop

User:Deldee/objectAnatomyDraft - Revision history

Deldee at 16:40, 11 October 2023

Deldee: started the draft of object anatomy

Deldee: Created page with "The following is a draft a full article on the object processes, to help debugging them for newcomers : Rough draft, using goomba as an example: Init - > [https://githu..."

Deldee: Created page with "The following is a draft a full article on the object processes, to help debugging them for newcomers : Rough draft, using goomba as an example:
Init - > [https://githu..."