Ninja Lights - Revision history

PkR at 03:10, 1 March 2026

2026-03-01T03:10:20Z

← Older revision		Revision as of 03:10, 1 March 2026
Line 51:		Line 51:
	njCalcVector( NULL, &light, &lwork );		njCalcVector( NULL, &light, &lwork );
	njSetEasyLight( lwork.x, lwork.y, lworkz );		njSetEasyLight( lwork.x, lwork.y, lworkz );
	</syntaxhighlight>After this, the Easy light source will be at <code>LIGHT3D_X,~~</code> <code>~~LIGHT3D_Y, LIGHT3D_Z</code>		</syntaxhighlight>After this, the Easy light source will be at <code>LIGHT3D_X, LIGHT3D_Y, LIGHT3D_Z</code>.
	\|}		\|}
	The SADX functions are a rough match since SADX changed draw functions for a lot of objects, and all that is left is some wrapper functions that call a more generic draw function:		The SADX functions are a rough match since SADX changed draw functions for a lot of objects, and all that is left is some wrapper functions that call a more generic draw function:

PkR at 03:09, 1 March 2026

2026-03-01T03:09:28Z

← Older revision		Revision as of 03:09, 1 March 2026
Line 46:		Line 46:
	\|<code>njEasyDrawObject</code> (0040A100), <code>njEasyDrawModel</code> (004084F0), <code>njEasyDrawMotion</code> (00406FA0), <code>njEasyDrawShapeMotion</code> (00406FE0)		\|<code>njEasyDrawObject</code> (0040A100), <code>njEasyDrawModel</code> (004084F0), <code>njEasyDrawMotion</code> (00406FA0), <code>njEasyDrawShapeMotion</code> (00406FE0)
	\|Uses one "easy" light (not <code>NJS_LIGHT</code>). Specular is not supported. From the SDK: The light vector uses the screen space coordinate system. E.g. if set up like <code>njSetEasyLight( 0.0f, 0.0f, 1.0f );</code>, the light source will always be in front of the screen. To set the light source in 3D space, they must be converted with the current matrix:<syntaxhighlight lang="cpp">		\|Uses one "easy" light (not <code>NJS_LIGHT</code>). Specular is not supported. From the SDK: The light vector uses the screen space coordinate system. E.g. if set up like <code>njSetEasyLight( 0.0f, 0.0f, 1.0f );</code>, the light source will always be in front of the screen. To set the light source in 3D space, they must be converted with the current matrix:<syntaxhighlight lang="cpp">
	light.x = LIGHT3D_X; light.y = LIGHT3D_Y;		light.x = LIGHT3D_X;
	light.z = LIGHT3D_Z; njCalcVector( NULL, &light, &lwork );		light.y = LIGHT3D_Y;
			light.z = LIGHT3D_Z;
			njCalcVector( NULL, &light, &lwork );
	njSetEasyLight( lwork.x, lwork.y, lworkz );		njSetEasyLight( lwork.x, lwork.y, lworkz );
	</syntaxhighlight>After this, the Easy light source will be at <code>LIGHT3D_X,</code> <code>LIGHT3D_Y, LIGHT3D_Z</code>		</syntaxhighlight>After this, the Easy light source will be at <code>LIGHT3D_X,</code> <code>LIGHT3D_Y, LIGHT3D_Z</code>

PkR at 03:08, 1 March 2026

2026-03-01T03:08:57Z

← Older revision		Revision as of 03:08, 1 March 2026
Line 3:		Line 3:
	== Ninja Lights in Sonic Adventure ==		== Ninja Lights in Sonic Adventure ==
	'''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.'''		'''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.'''

	Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based [[Sonic Adventure/Lantern Engine\|LANTERN system]] and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on the function used the game can either draw the model with palette lighting or use Ninja Lights.		Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based [[Sonic Adventure/Lantern Engine\|LANTERN system]] and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on the function used the game can either draw the model with palette lighting or use Ninja Lights.

PkR at 03:06, 1 March 2026

2026-03-01T03:06:16Z

← Older revision		Revision as of 03:06, 1 March 2026
Line 3:		Line 3:
	== Ninja Lights in Sonic Adventure ==		== Ninja Lights in Sonic Adventure ==
	'''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.'''		'''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.'''
	Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based [[Lantern Engine\|LANTERN system]] and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on the function used the game can either draw the model with palette lighting or use Ninja Lights.		Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based [[Sonic Adventure/Lantern Engine\|LANTERN system]] and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on the function used the game can either draw the model with palette lighting or use Ninja Lights.

	The SL file contains data for setting up the Ninja lights. This information consists of: light color (three floats for R/G/B), diffuse multiplier, specular power and ambient multiplier. Both diffuse and specular components are the same color. The “ignore specular” material flag disables the specular component per mesh.		The SL file contains data for setting up the Ninja lights. This information consists of: light color (three floats for R/G/B), diffuse multiplier, specular power and ambient multiplier. Both diffuse and specular components are the same color. The “ignore specular” material flag disables the specular component per mesh.

PkR: Created page with ""Ninja Lights" refers to the lighting used by the Ninja library of the Katana SDK. == Ninja Lights in Sonic Adventure == '''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.''' Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based LANTERN system and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on..."

2026-03-01T03:03:52Z

Created page with ""Ninja Lights" refers to the lighting used by the Ninja library of the Katana SDK. == Ninja Lights in Sonic Adventure == '''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.''' Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based LANTERN system and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on..."

New page

"Ninja Lights" refers to the lighting used by the Ninja library of the [[Katana SDK]].

== Ninja Lights in Sonic Adventure ==
'''Note: Ninja Lights are not implemented in the Lantern Engine mod, so the information below is irrelevant to the PC version.'''
Sonic Adventure (Dreamcast) uses two lighting systems: the palette-based [[Lantern Engine|LANTERN system]] and the Ninja Lights. The game's model rendering functions have "Lantern" and "Ninja" variants, and depending on the function used the game can either draw the model with palette lighting or use Ninja Lights.

The SL file contains data for setting up the Ninja lights. This information consists of: light color (three floats for R/G/B), diffuse multiplier, specular power and ambient multiplier. Both diffuse and specular components are the same color. The “ignore specular” material flag disables the specular component per mesh.

=== Types of Ninja Lights Setup ===
There are three types of lights used for non-palettized models in the game:
{| class="wikitable"
!Lighting Setup
!Description
!Used by
|-
|Two Ninja Lights
|Non-palettized lighting that uses two Ninja Lights. These lights use <code>NJS_LIGHT</code> structures described in the Katana SDK. One is set up using the parameters in the SL file (let’s call it the <code>ENV</code> Light), and the other is set up in code, usually in level binaries (let’s call it the <code>DIR</code> light). The <code>ENV</code> light has one configurable color that is shared for diffuse and specular, the <code>DIR</code> light can have different diffuse and specular color (though the game doesn’t seem to use that). It can also have a different light direction.
|Common switch, Hint monitor, OEggKanban (glowing Eggman logo in Final Egg, tube parts only), Chaos puddle in some cutscenes, Aoki Switch (top)
|-
|Simple Ninja Light
|Non-palettized lighting that uses one Ninja Light using the parameters from the SL file except the color, which is always white.
|Rock bits in Red Mountain, non-Jewel Chao, Master Emerald pieces, Froggy in Gamma’s Emerald Coast
|-
|Easy Light
|Non-palettized lighting that sets up the Easy Light (not <code>NJS_LIGHT</code>) using the parameters from the SL file. The Easy light is described in the Katana SDK. It doesn’t support specular lighting.
|Snowboard, OSandSwitch (Sand Hill switch), shadow blob, Chambr (chambers with opening doors in Sky Deck), debug objects, Aoki Switch (bottom), E101’s missiles, Hedgehog Hammer targets
|}

=== Rendering Functions and their SADX Counterparts ===
In SA1, most models were rendered with palette lighting using the game's custom function, but some models were rendered by calling Ninja drawing functions directly, which made them use the Ninja lights system. There are three light setups depending on the specific variation of the Ninja draw function:
{| class="wikitable"
!Light setup
!Functions in SADX (PC, 2004)
!Comment
|-
|Regular
|<code>njDrawModel</code> (0077EF70)
|Allows to use multiple <code>NJS_LIGHT</code>s of various types (directional, point, spot). Specular is supported.
|-
|Simple
|<code>___SAnjSimpleDrawModel</code> (00408520), <code>__SAnjSimpleDrawObject</code> (0040A130)
|Only the first registered <code>NJS_LIGHT</code> can be used. It is set up as a directional light, and intensity and color settings cannot be adjusted. Specular is supported.
|-
|Easy
|<code>njEasyDrawObject</code> (0040A100), <code>njEasyDrawModel</code> (004084F0), <code>njEasyDrawMotion</code> (00406FA0), <code>njEasyDrawShapeMotion</code> (00406FE0)
|Uses one "easy" light (not <code>NJS_LIGHT</code>). Specular is not supported. From the SDK: The light vector uses the screen space coordinate system. E.g. if set up like <code>njSetEasyLight( 0.0f, 0.0f, 1.0f );</code>, the light source will always be in front of the screen. To set the light source in 3D space, they must be converted with the current matrix:<syntaxhighlight lang="cpp">
light.x = LIGHT3D_X; light.y = LIGHT3D_Y;
light.z = LIGHT3D_Z; njCalcVector( NULL, &light, &lwork );
njSetEasyLight( lwork.x, lwork.y, lworkz );
</syntaxhighlight>After this, the Easy light source will be at <code>LIGHT3D_X,</code> <code>LIGHT3D_Y, LIGHT3D_Z</code>
|}
The SADX functions are a rough match since SADX changed draw functions for a lot of objects, and all that is left is some wrapper functions that call a more generic draw function:

# The Regular functions are difficult to tell from the paletted functions, so the above table is an approximation.
# The Easy functions are mostly still there.
# The Simple functions only have two stubs which aren't called by anything other than the Chao Name Machine, which doesn't match SA1.

=== Lighting Data ===
The data sources for the lights are as follows:
{| class="wikitable"
!Light
!Type
!Direction
!Color
!Diffuse, specular, ambient intensity
|-
|Regular - light 1
|Directional
|<code>(0, -1, 0)</code> rotated using <code>RY</code> and <code>RZ</code> values from the SL file
|From the SL file
|From the SL file
|-
|Regular - light 2
|Directional
|<code>njSetLightDirection</code> called in the skybox display function
|<code>njSetLightColor</code> called in the skybox display function
|<code>njSetLightIntensity</code> called in the skybox display function
|-
|Simple
|Directional
|<code>(0, -1, 0)</code> rotated using <code>RY</code> and <code>RZ</code> values from the SL file
|White (in SA1 anyway)
|From the SL file
|-
|Easy
|Directional
|<code>(0, -1, 0)</code> rotated using <code>RY</code> and <code>RZ</code> values from the SL file
|From the SL file
|From the SL file, no specular
|}
In addition to these lights, there can be custom lights set up by objects' code, which will affect all objects rendered with Regular functions. These custom lights can be directional, spot or point, with or without specular. The custom lights are created with the function <code>le_CreateLight</code> (0040A510 in SADX) and deleted with the function <code>le_DeleteLight</code> (0040A550 in SADX).

In the Dreamcast version, these functions use pointers to actual <code>NJS_LIGHT</code>s. In SADX, the Ninja Lights system appears to have been replaced by a system using the structure <code>LE_LIGHT_ENV</code> (what is also known as "Stage lights"). Instead of specific pointers, there is now an array of four "current stage lights" called <code>le_env</code> at 03ABD9F8. It also has a corresponding array of four Ninja light flags <code>le_env_typ</code> at 03ABDBB8. So instead of <code>NJS_LIGHT</code> pointers, the light create/delete functions manipulate data in these arrays in SADX.

Interestingly enough, the data for the light "Regular- light 2" is completely the same in SADX. It's still set up by the skybox display functions which call <code>njSetLightColor</code> etc. with the same arguments as the Dreamcast version, so basically we don't need the data from this post. However, now that these functions are redirected to modify the first entry in the <code>le_env</code> array, this data is overwritten every time a stage loads. That is happening because the function <code>le_set_env</code> (0040A95) copies over all light data from the SADX stage lights array (00900E88), which happens every time a light type is set and whenever a new level loads.

The following behavior of Ninja Lights is different from palette lighting:

<code>NJD_FLAG_IGNORE_SPECULAR</code> disables specular lighting ''completely'' (per material).

<code>NJD_FLAG_USE_FLAT</code> enables flat shading (used by Master Emerald pieces).

=== '''Custom''' '''Lights''' ===
There's a leftover function in SADX that creates custom lights associated with specific objects: <code>asSetLight</code> at 0040ADC0. It uses a <code>taskwk</code> pointer, an <code>NJS_LIGHT</code> pointer and a pointer to a structure called <code>LightInfo</code>:<syntaxhighlight lang="cpp">
struct LightInfo
{
int lsrc; // Ninja light flags
float spc;
float dif;
float amb;
NJS_ARGB argb;
NJS_POINT3 pos; // Light position (for spot and point lights)
NJS_POINT3 vec; // Light direction
float nrang; // Distance at which light source attenuation begins
float frang; // Distance to cut the effect of the light source (range)
int iang; // The angle at which the specular or spotlight is at maximum intensity
int oang; // The angle at which the specular or spotlight effect ceases
};
</syntaxhighlight>The following Ninja light flags can be used. The ones in bold are used in SA1, and the ones crossed out are unlikely to have been used in SA1.
{| class="wikitable"
!Flags
!Flag name
!Light type
!Ambient
!Diffuse
!Specular
|-
|0x01
|NJD_AMBIENT
|Ambient
|〇
|×
|×
|-
|0x02
|NJD_DIR_LIGHT
|Directional
|×
|〇
|×
|-
|0x03
|'''NJD_LAMBERT_DIR'''
|Directional
|〇
|〇
|×
|-
|0x04
|'''NJD_POINT_LIGHT'''
|Point
|×
|〇
|×
|-
|0x05
|NJD_LAMBERT_POINT
|Point
|〇
|〇
|×
|-
|0x08
|NJD_SPOT_LIGHT
|Spot
|×
|〇
|×
|-
|0x10
|NJD_SPEC_DIR
|Directional
|×
|〇
|〇
|-
|0x13
|NJD_PHONG_DIR
|Directional
|〇
|〇
|〇
|-
|0x20
|NJD_SPEC_POINT
|Point
|×
|〇
|〇
|-
|0x25
|'''NJD_PHONG_POINT'''
|Point
|〇
|〇
|〇
|-
|0x40
|<del>NJD_USER_LIGHT</del>
|Call a custom callback function
|
|
|
|-
|0x80
|'''NJD_SIMPLE_LIGHT'''
|Simplified lighting calculations (NOT the "Simple light" described earlier)
|
|
|
|-
|0xC0
|<del>NJD_BLOCK_LIGHT</del>
|Simplified lighting calculations
|
|
|
|}
The following custom lights have some leftover code and data in SADX. These also exist in SA1 but they aren't visible normally because the models that were supposed to be lit by them are rendered with palette lighting.

# Ice Cap background light: <code>NJD_PHONG_POINT</code>, <code>LightInfo</code> structure at 00C67FA0. Uses angles.
# "Chaos underlight": <code>NJD_POINT_LIGHT</code>, <code>NJS_LIGHT</code> structure at 03D0D5B8. The light is initialized using the function <code>ChaosUnderLightInit</code> (007AD250) that has a "radius" argument which goes unused in SADX but in SA1 it should be the light range. In Chaos' main functions, the light's matrix is transformed to match Chaos' position.
# Some light in Knuckles' story cutscene: <code>NJD_SIMPLE_LIGHT | NJD_LAMBERT_DIR</code>, function at 006868F0.
# Lights in Gamma's briefing cutscene: <code>NJD_SIMPLE_LIGHT | NJD_LAMBERT_DIR</code>, function at 006F4570. The light is a leftover, but this effect was adapted to palette lighting, and palette-related functions are called here too.

=== '''Specular''' '''Lighting''' ===
The Specular calculation formula for the Ninja Lights is currently unknown for Basic models. For Chunk models (which SA1 DC doesn't use), the formula was reversed by ''Exant'' for Simple and Easy lights:
[[File:Ninja Lights 1772333955721.png|none]]