Custom object - Revision history

Tenry: add link to object list

2020-11-09T06:39:16Z

add link to object list

Tenry at 06:30, 9 November 2020

2020-11-09T06:30:40Z

Tenry at 17:32, 8 November 2020

2020-11-08T17:32:24Z

Tenry at 17:09, 5 November 2020

2020-11-05T17:09:17Z

Tenry at 16:25, 5 November 2020

2020-11-05T16:25:42Z

Tenry at 20:14, 1 November 2020

2020-11-01T20:14:27Z

Tenry at 20:12, 1 November 2020

2020-11-01T20:12:47Z

Tenry: Tenry moved page Custom behavior to Custom object

2020-11-01T20:09:18Z

Tenry moved page Custom behavior to Custom object

Tenry: Created page with "This page describes how to create a custom object with custom 3D model and custom behavior for Super Mario 64. == Export 3D model (Fast64) == In Blender, install the..."

2020-11-01T20:08:50Z

Created page with "This page describes how to create a custom object with custom 3D model and custom behavior for Super Mario 64. == Export 3D model (Fast64) == In Blender, install the..."

New page

This page describes how to create a custom object with custom 3D model and custom [[behavior]] for Super Mario 64.

== Export 3D model (Fast64) ==
In [[Blender]], install the [[Fast64]] plugin, select your object you want to export, open the Fast64 menu and expand '''SM64 Geolayout Exporter'''. Ensure to select [[C]] as the export.

Choose '''Actor Data''' as the export type.

Choose a group name you want to add your actor to, such as '''common0'''.

Choose a unique folder name. It's recommended to add the word ''custom'' to the name, for example '''custom_platform'''.

Choose a unique [[Geometry layout|geolayout]] name, such as '''custom_platform_geo'''.

Ensure the newly created '''model.inc.c''' file is included in actors/''<group>''.c file, such as in '''actors/common0.c'''.

Ensure the newly created '''geo_header.h''' file is included in actors/''<group>''.h file, such as in '''actors/common0.h'''.

Ensure the newly created '''geo.inc.c''' file is included in actors/''<group>''_geo.c file, such as in '''actors/common0_geo.c'''.

== Load custom model ==
It's a good idea to give your 3D model a unique name, such as '''MODEL_CUSTOM_COIN''', and an ID from 0x00 to 0xFF. Define it in '''include/model_ids.h'''. Ensure it does not share an ID with another model that might be loaded in the same level.

In your level script file (such as '''levels/bob/script.c''') or in a global script located in '''levels/scripts.c''', add a ''LOAD_MODEL_FROM_GEO'' command, such as '''LOAD_MODEL_FROM_GEO(MODEL_CUSTOM_COIN, custom_coin_geo)'''.

== Create behavior script ==
Open '''data/behavior_data.c''' in your favorite code editor. You may want to add a dedicated file, such as '''data/custom_coin.inc.c''' and include this in data/behavior_data.c.

The easiest way to create your own behavior script is to copy an existing one that's most closely to what you want. Copy the related lines and rename the variable accordingly. Example:<syntaxhighlight lang="c" line="1">
// original yellow coin (for reference)
const BehaviorScript bhvYellowCoin[] = {
BEGIN(OBJ_LIST_LEVEL),
BILLBOARD(),
OR_INT(oFlags, (OBJ_FLAG_COMPUTE_DIST_TO_MARIO | OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE)),
CALL_NATIVE(bhv_yellow_coin_init), // defined in src/game/behaviors/coin.inc.c
BEGIN_LOOP(),
CALL_NATIVE(bhv_yellow_coin_loop), // defined in src/game/behaviors/coin.inc.c
END_LOOP(),
};

// your own copy
const BehaviorScript bhvCustomCoin[] = {
BEGIN(OBJ_LIST_LEVEL),
BILLBOARD(),
OR_INT(oFlags, (OBJ_FLAG_COMPUTE_DIST_TO_MARIO | OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE)),
CALL_NATIVE(bhv_custom_coin_init), // define your own in src/game/behaviors/custom_coin.inc.c
BEGIN_LOOP(),
CALL_NATIVE(bhv_custom_coin_loop), // define your own in src/game/behaviors/custom_coin.inc.c
END_LOOP(),
};
</syntaxhighlight>

== Create native code ==
If you need new native [[C]] code, create a new code file in src/game/behaviors, such as '''src/game/behaviors/custom_coin.inc.c''', and include that file in '''src/game/obj_behaviors.c'''. You might want to copy an existing behavior code for reference. However, make sure all variables and function names are unique in the source code. For example, rename '''bhv_yelow_coin_loop''' to '''bhv_custom_coin_loop'''.

@@ Line 72: / Line 72: @@
 * [[Fast64]]
 * [[Behavior]]
 * [[Geometry layout]]
 [[Category:Level]]

← Older revision		Revision as of 17:32, 8 November 2020
Line 65:		Line 65:
	* [[Behavior]]		* [[Behavior]]
	* [[Geometry layout]]		* [[Geometry layout]]
		+	[[Category:Level]]

← Older revision		Revision as of 20:14, 1 November 2020
Line 59:		Line 59:

	Set behavior to '''Custom''' and behavior name to your defined name in data/behavior_data.c, such as '''bhvCustomCoin'''.		Set behavior to '''Custom''' and behavior name to your defined name in data/behavior_data.c, such as '''bhvCustomCoin'''.
		+
		+	== See also ==
		+
		+	* [[Fast64]]
		+	* [[Behavior]]
		+	* [[Geometry layout]]

← Older revision		Revision as of 20:12, 1 November 2020
Line 52:		Line 52:
	== Create native code ==		== Create native code ==
	If you need new native [[C]] code, create a new code file in src/game/behaviors, such as '''src/game/behaviors/custom_coin.inc.c''', and include that file in '''src/game/obj_behaviors.c'''. You might want to copy an existing behavior code for reference. However, make sure all variables and function names are unique in the source code. For example, rename '''bhv_yelow_coin_loop''' to '''bhv_custom_coin_loop'''.		If you need new native [[C]] code, create a new code file in src/game/behaviors, such as '''src/game/behaviors/custom_coin.inc.c''', and include that file in '''src/game/obj_behaviors.c'''. You might want to copy an existing behavior code for reference. However, make sure all variables and function names are unique in the source code. For example, rename '''bhv_yelow_coin_loop''' to '''bhv_custom_coin_loop'''.
		+
		+	== Add object to level (Fast64) ==
		+	In your level inside [[Blender]], add an ''Empty''. Set object type to '''Object'''.
		+
		+	Set model to '''Custom''' and model ID to your defined ID from include/model_ids.h, such as '''MODEL_CUSTOM_COIN'''.
		+
		+	Set behavior to '''Custom''' and behavior name to your defined name in data/behavior_data.c, such as '''bhvCustomCoin'''.

@@ Line 17: / Line 17: @@
 Ensure the newly created '''geo.inc.c''' file is included in actors/''<group>''_geo.c file, such as in '''actors/common0_geo.c''' (should be done by Fast64 exporter).
 == Load custom model ==
@@ Line 49: / Line 54: @@
 };
 </syntaxhighlight>
 == Create native code ==

@@ Line 24: / Line 24: @@
 == Create behavior script ==
-Open '''data/behavior_data.c''' in your favorite code editor. You may want to add a dedicated file, such as '''data/custom_coin.inc.c''' and include this in data/behavior_data.c.
+Open '''data/behavior_data.c''' in your favorite code editor. You may want to add a dedicated file, such as '''data/custom_coin.inc.c''' and include this in data/behavior_data.c. Also add your new behavior name to '''include/behavior_data.h'''.
 The easiest way to create your own behavior script is to copy an existing one that's most closely to what you want. Copy the related lines and rename the variable accordingly. Example:<syntaxhighlight lang="c" line="1">
@@ Line 51: / Line 51: @@
 == Create native code ==
-If you need new native [[C]] code, create a new code file in src/game/behaviors, such as '''src/game/behaviors/custom_coin.inc.c''', and include that file in '''src/game/obj_behaviors.c'''. You might want to copy an existing behavior code for reference. However, make sure all variables and function names are unique in the source code. For example, rename '''bhv_yelow_coin_loop''' to '''bhv_custom_coin_loop'''.
+If you need new native [[C]] code, create a new code file in src/game/behaviors, such as '''src/game/behaviors/custom_coin.inc.c''', and include that file in '''src/game/obj_behaviors.c'''. You might want to copy an existing behavior code for reference. However, make sure all variables and function names are unique in the source code. For example, rename '''bhv_yelow_coin_loop''' to '''bhv_custom_coin_loop'''. Declare your custom functions in a suitable header file, such as in '''src/game/obj_behaviors.h''' or '''src/game/behavior_actions.h'''.
 == Add object to level (Fast64) ==

@@ Line 12: / Line 12: @@
 Choose a unique [[Geometry layout|geolayout]] name, such as '''custom_platform_geo'''.
-Ensure the newly created '''model.inc.c''' file is included in actors/''<group>''.c file, such as in '''actors/common0.c'''.
+Ensure the newly created '''model.inc.c''' file is included in actors/''<group>''.c file, such as in '''actors/common0.c''' (should be done by Fast64 exporter).
-Ensure the newly created '''geo_header.h''' file is included in actors/''<group>''.h file, such as in '''actors/common0.h'''.
+Ensure the newly created '''geo_header.h''' file is included in actors/''<group>''.h file, such as in '''actors/common0.h''' (should be done by Fast64 exporter).
-Ensure the newly created '''geo.inc.c''' file is included in actors/''<group>''_geo.c file, such as in '''actors/common0_geo.c'''.
+Ensure the newly created '''geo.inc.c''' file is included in actors/''<group>''_geo.c file, such as in '''actors/common0_geo.c''' (should be done by Fast64 exporter).
 == Load custom model ==