Prototype/Decorative: Difference between revisions

Revision as of 12:56, 23 April 2021

Prototype definitions » PrototypeBase » Prototype/Decorative

Simple decorative purpose objects on the map, they have no health and some of them are removed when the player builds over. Usually used for grass patches, roots, small plants etc. Only 255 instances of this prototype may be defined.

Prototype/Decorative — `optimized-decorative`
pictures	::	SpriteVariations
autoplace	::	AutoplaceSpecification (optional)
collision_box	::	BoundingBox (optional)
collision_mask	::	CollisionMask (optional)
decal_overdraw_priority	::	uint16 (optional)
grows_through_rail_path	::	bool (optional)
render_layer	::	RenderLayer (optional)
tile_layer	::	int16 (optional)
trigger_effect	::	TriggerEffect (optional)
walking_sound	::	Sound (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Mandatory properties

This prototype inherits all the properties from PrototypeBase.

pictures

Type: SpriteVariations
Must contain at least 1 picture.

Optional properties

collision_box

Type: BoundingBox
Must contain the [0,0] point. Max radius of the collision box is 8.

render_layer

Type: RenderLayer
Default: "decorative"

grows_through_rail_path

Type: bool
Default: false

tile_layer

Type: int16
Default: 0
Mandatory if render_layer = "decals". This int16 is converted to a RenderLayer internally.

decal_overdraw_priority

Type: uint16
Default: 0
Loaded only if render_layer = "decals".

walking_sound

Type: Sound

trigger_effect

Type: TriggerEffect
Called by DestroyDecorativesTriggerEffectItem.

autoplace

Type: AutoplaceSpecification

collision_mask

Type: CollisionMask
Default: "doodad-layer"

@@ Line 1: / Line 1: @@
-== Basics ==
+{{Prototype parent|PrototypeBase}}
-Prototype type: '''optimized-decorative'''
+Simple decorative purpose objects on the map, they have no health and some of them are removed when the player builds over. Usually used for grass patches, roots, small plants etc. Only 255 instances of this prototype may be defined.
-Extends [[Prototype]].
+{{Prototype TOC|optimized-decorative}}
 == Mandatory properties ==
-This prototype inherits all the properties from [[Prototype]].
+This prototype inherits all the properties from [[PrototypeBase]].
-=== pictures ===
-'''Type''': [[Types/SpriteVariations]]
+{{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]}}
 Must contain at least 1 picture.
 == Optional properties ==
-=== collision_box ===
+{{Prototype property|collision_box|[[Types/BoundingBox|BoundingBox]]|optional=true}}
-'''Type''': [[Types/BoundingBox]]
 Must contain the [0,0] point. Max radius of the collision box is 8.
-=== render_layer ===
+{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"decorative"|optional=true}}
-'''Type''': [[Types/RenderLayer]]
-'''Default''': "decorative"
-=== grows_through_rail_path ===
-'''Type''': [[Types/bool]]
-'''Default''': false
+{{Prototype property|grows_through_rail_path|[[Types/bool|bool]]|false|optional=true}}
-=== tile_layer ===
+{{Prototype property|tile_layer|[[Types/int16|int16]]|0|optional=true}}
-'''Type''': [[Types/uint8]]
+Mandatory if <code>render_layer</code> = "decals". This int16 is converted to a [[Types/RenderLayer|RenderLayer]] internally.
-'''Default''': 0
+{{Prototype property|decal_overdraw_priority|[[Types/uint16|uint16]]|0|optional=true}}
+Loaded only if <code>render_layer</code> = "decals".
-Mandatory if <code>render_layer</code> = "decals". This uint8 is converted to a [[Types/RenderLayer]] internally.
+{{Prototype property|walking_sound|[[Types/Sound|Sound]]|optional=true}}
-=== autoplace ===
+{{Prototype property|trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
-'''Type''': [[Types/AutoplaceSpecification]]
+Called by [[Types/DestroyDecorativesTriggerEffectItem|DestroyDecorativesTriggerEffectItem]].
-=== collision_mask ===
+{{Prototype property|autoplace|[[Types/AutoplaceSpecification|AutoplaceSpecification]]|optional=true}}
-'''Type''': [[Types/CollisionMask]]
-'''Default''': "doodad-layer"
+{{Prototype property|collision_mask|[[Types/CollisionMask|CollisionMask]]|"doodad-layer"|optional=true}}