Overgrowth Object Xml File Format - Revision history

Merlyn: /* Object XML -> Label element */

2023-09-11T04:59:02Z

Object XML -> Label element

← Older revision		Revision as of 21:59, 10 September 2023
Line 202:		Line 202:
	</pre>		</pre>

	'''Required''' - String value. This is referenced by ~~the editor~~ to ~~display~~ a ~~label for the object in the level~~, ~~while in edit mode.~~<br>		'''Required''' - String value. This is referenced by gameplay scripts, to determine if this object is of a certain type (e.g. <code>spear</code>, <code>scabbard</code>, <code>impale</code>, etc).
	~~'''TODO''': Is this right? Or is it for gameplay scripting? -merlyn~~

	== Object XML -> WeightMap element ==		== Object XML -> WeightMap element ==

Merlyn: /* Object XML -> Label element */

2023-09-11T04:37:49Z

Object XML -> Label element

← Older revision		Revision as of 21:37, 10 September 2023
Line 194:		Line 194:
	</pre>		</pre>

	'''Optional''' - This is referenced by gameplay scripts, to determine if this object is of a certain type (e.g. <code>spear</code>, <code>impale</code>, etc).		'''Optional''' - This is referenced by gameplay scripts, to determine if this object is of a certain type (e.g. <code>spear</code>, <code>scabbard</code>, <code>impale</code>, etc).

	=== Label element -> element text ===		=== Label element -> element text ===

Merlyn: /* Object XML -> Label element */

2023-09-11T04:37:13Z

Object XML -> Label element

← Older revision		Revision as of 21:37, 10 September 2023
Line 194:		Line 194:
	</pre>		</pre>

	'''Optional''' - This is referenced by ~~the editor~~ to ~~display~~ a ~~label for the object in the level~~, ~~while in edit mode.~~<br>		'''Optional''' - This is referenced by gameplay scripts, to determine if this object is of a certain type (e.g. <code>spear</code>, <code>impale</code>, etc).
	~~'''TODO''': Is this right? Or is it for gameplay scripting? -merlyn~~

	=== Label element -> element text ===		=== Label element -> element text ===

Merlyn: /* Object XML -> avg_color element */

2023-09-11T04:30:17Z

Object XML -> avg_color element

← Older revision		Revision as of 21:30, 10 September 2023
Line 527:		Line 527:
	</pre>		</pre>

	'''Optional''' - The default value is <code>r = 200, g = 200, b = 200</code>, which is equivalent to a light grey. The color ~~that~~ the object ~~should use for rendering acceleration~~, e.~~g. if a texture hasn't loaded in~~, ~~or for simplified lighting.<br>~~		'''Optional''' - The default value is <code>r = 200, g = 200, b = 200</code>, which is equivalent to a light grey. The color is used when the object is used as a detail object, and the detail is faded out while getting close to the max allowed draw distance. For other scenarios, such as when just placing the object normally in a level, the value seems to go unused.
	~~'''TODO''': Is this even remotely correct? Kinda~~ just ~~guessing~~, ~~without looking at~~ the ~~code~~. ~~-merlyn~~

	=== avg_color element -> r attribute ===		=== avg_color element -> r attribute ===

Merlyn: /* Object XML -> avg_color element */

2023-09-11T04:06:46Z

Object XML -> avg_color element

← Older revision		Revision as of 21:06, 10 September 2023
Line 527:		Line 527:
	</pre>		</pre>

	'''Optional''' - The color that the object should use for rendering acceleration, e.g. if a texture hasn't loaded in, or for simplified lighting.<br>		'''Optional''' - The default value is <code>r = 200, g = 200, b = 200</code>, which is equivalent to a light grey. The color that the object should use for rendering acceleration, e.g. if a texture hasn't loaded in, or for simplified lighting.<br>
	'''TODO''': Is this even remotely correct? Kinda just guessing, without looking at the code. -merlyn		'''TODO''': Is this even remotely correct? Kinda just guessing, without looking at the code. -merlyn

Merlyn: /* Object XML -> ColorTint element */

2023-09-11T04:04:39Z

Object XML -> ColorTint element

← Older revision		Revision as of 21:04, 10 September 2023
Line 682:		Line 682:
	</pre>		</pre>

	'''Optional''' - The color that the object should be tinted, by default. This can be overridden in the editor after the object is placed ~~in the world~~.		'''Optional''' - The default value is <code>r = 255, g = 255, b = 255</code>, which is equivalent to no tint. The color that the object should be tinted, by default, when placed in the world. This can be overridden in the editor after the object is placed.

	=== ColorTint element -> r attribute ===		=== ColorTint element -> r attribute ===

Merlyn: /* Object XML -> GroundOffset element */

2023-09-11T03:49:23Z

Object XML -> GroundOffset element

← Older revision		Revision as of 20:49, 10 September 2023
Line 663:		Line 663:
	</pre>		</pre>

	'''Optional''' - The Y offset to position this object away from the ground, when placed in the world.		'''Optional''' - The default value is <code>0.0</code>. The Y offset to position this object away from the ground, when placed in the world.

	=== GroundOffset element -> element text ===		=== GroundOffset element -> element text ===
Line 671:		Line 671:
	</pre>		</pre>

	'''Required''' - Decimal value. The Y offset to position this object away from the ground, when placed in the world.		'''Required''' - Decimal value. The default value (when the element is not present) is <code>0.0</code>. The Y offset to position this object away from the ground, when placed in the world.

	== Object XML -> ColorTint element ==		== Object XML -> ColorTint element ==

Merlyn: /* Object XML -> Flags element */

2023-09-11T03:44:59Z

Object XML -> Flags element

← Older revision		Revision as of 20:44, 10 September 2023
Line 601:		Line 601:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will be rendered in the transparent rendering pass.<br>		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will be rendered in the transparent rendering pass.<br>
	This flag doesn't make the object transparent on its own, and must also be coupled with transparent shader flags and a transparency map texture.		This flag doesn't make the object transparent on its own, and must also be coupled with transparent shader flags and a transparency map texture.

Line 610:		Line 610:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will not trigger collisions with players, items, or weapons.<br>		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will not trigger collisions with players, items, or weapons.<br>

	=== Flags element -> clamp_texture attribute ===		=== Flags element -> clamp_texture attribute ===
Line 618:		Line 618:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will render with its texture clamped at its edges, instead of repeating.<br>		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will render with its texture clamped at its edges, instead of repeating.<br>

	=== Flags element -> bush_collision attribute ===		=== Flags element -> bush_collision attribute ===
Line 626:		Line 626:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will trigger jiggle physics when items and characters collide with it. Physics objects will also be slowed down when interacting with it, but not completely blocked. It will also impact line of sight.		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will trigger jiggle physics when items and characters collide with it. Physics objects will also be slowed down when interacting with it, but not completely blocked. It will also impact line of sight.

	=== Flags element -> terrain_fixed attribute ===		=== Flags element -> terrain_fixed attribute ===
Line 634:		Line 634:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will be locked to the terrain when placed.<br>		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will be locked to the terrain when placed.<br>
	'''TODO''': Is this an accurate description, or does it do something else? -merlyn		'''TODO''': Is this an accurate description, or does it do something else? -merlyn

Line 643:		Line 643:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will be considered to move by script, and the physics engine will use that information for optimization<br>		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will be considered to move by script, and the physics engine will use that information for optimization<br>
	'''TODO''': Is this an accurate description, or does it do something else? -merlyn		'''TODO''': Is this an accurate description, or does it do something else? -merlyn

Line 652:		Line 652:
	</pre>		</pre>

	'''Optional''' - Boolean value. If <code>true</code>, then the object will have its polygons rendered double-sided. This is useful for objects such as flags and cloth, that have no thickness.		'''Optional''' - Boolean value. The default value is <code>false</code>. If <code>true</code>, then the object will have its polygons rendered double-sided. This is useful for objects such as flags and cloth, that have no thickness.

	== Object XML -> GroundOffset element ==		== Object XML -> GroundOffset element ==

Merlyn: /* DetailObject element -> collision_type attribute */

2023-09-11T03:42:06Z

DetailObject element -> collision_type attribute

← Older revision		Revision as of 20:42, 10 September 2023
Line 495:		Line 495:
	</pre>		</pre>

	'''Optional''' - Enumerated value. Specifies the type of collision this object should have with moving objects in the world. Valid values are <code>static</code>, <code>plant</code>, and unset~~.<br>~~		'''Optional''' - Enumerated value. The default value is unset, which will result in an object with dynamic collision. Specifies the type of collision this object should have with moving objects in the world. Valid values are <code>static</code>, <code>plant</code>, and unset.
	~~The default value is unset, which will result in an object with dynamic collision~~.

	== Object XML -> ShaderName element ==		== Object XML -> ShaderName element ==

Merlyn: /* DetailObject element -> tint_weight attribute */

2023-09-11T03:41:38Z

DetailObject element -> tint_weight attribute

← Older revision		Revision as of 20:41, 10 September 2023
Line 486:		Line 486:
	</pre>		</pre>

	'''Optional''' - Decimal value. Specifies the blend percentage between the detail object's tint, and the tint it inherits from the object's surface it decorates. The value should be between <code>0.0</code> and <code>1.0</code>.<br>		'''Optional''' - Decimal value. The default value is <code>1.0</code>. Specifies the blend percentage between the detail object's tint, and the tint it inherits from the object's surface it decorates. The value should be between <code>0.0</code> and <code>1.0</code>.<br>
	'''TODO''': ~~Default value~~? -merlyn		'''TODO''': Is this accurate? Is it the blend with other detail object layers or the parent layer? -merlyn

	=== DetailObject element -> collision_type attribute ===		=== DetailObject element -> collision_type attribute ===