Entity welding – Ylands
No edit summary |
Lou Montana (talk | contribs) m (Text replacement - "Category: How-to" to "Category: Ylands: How To") |
||
| (11 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
=Overview= | =Overview= | ||
Entity welding is feature, which allows to merge multiple entities in to one. Entities welded together will have new, optimized collision envelope, which leads to better performance in game. Welding large structures consisting from hundreds of individual pieces is resource demanding proces and could take even several minutes to complete, but it is essential optimization tool. | Entity '''welding''' is feature, which allows to '''merge multiple entities''' in to one. Entities welded together will have new, '''optimized collision''' envelope, which leads to '''better performance''' in game. Welding large structures consisting from hundreds of individual pieces is resource demanding proces and could take even several minutes to complete, but it is '''essential optimization tool'''. | ||
Images below show comparison between welded and unwelded entity, improvement in this particular case is 62%. '''Note:''' These are not actual entity colors, but collision visualization. | Images below show comparison between welded and unwelded entity, '''improvement''' in this particular case is '''62%'''. '''Note:''' These are not actual entity colors, but collision visualization. | ||
<gallery> | <gallery> | ||
Image:Ylands-Editor-entity_welding_before.jpg|Colliders before weld | Image:Ylands-Editor-entity_welding_before.jpg|Colliders before weld | ||
| Line 8: | Line 8: | ||
</gallery> | </gallery> | ||
Welding works similar as object grouping, but it is available only for compatible entities. Entity weld is new game object and is threatened in same manner as entity - it can be referenced in script or included in a groups. Weld also provides similar editing options as | Welding works '''similar''' as object '''grouping''', but it is available only for '''compatible entities'''. Entity weld is '''new game object''' and is threatened in same manner as entity - it can be referenced in script or included in a groups. Weld also provides similar editing options as object group - it is possible to cancel the weld or edit welded entities on individual level. | ||
===Note:=== | |||
*type '''/collidercount''' to console to see total collider count in the scene. | |||
==Welding entities== | ==Welding entities== | ||
When valid entities are selected, '''Weld entities''' option in object selection menu will become available. This button will initiate the merge process and create Entity weld. If incompatible entities are also selected, they will be automatically excluded from the welding process. | |||
When valid entities are selected, | |||
===Entities that cannot be welded=== | ===Entities that cannot be welded=== | ||
| Line 27: | Line 29: | ||
</gallery> | </gallery> | ||
=Global welding= | |||
It is also possible to perform '''global welding''', which will divide the world in small chunks and will '''merge all eligible objects''' in each chunks in to one weld. Global welding can be performed via '''Export -> Optimize''' in editor main menu. Depending on the size of map and number of used objects, this process can take up to '''several minutes or even hours'''. Optimized scenario then has to be saved in order to preserve newly created entity welds. | |||
<gallery> | |||
Image:Ylands-Editor-entity welding optimize.png | |||
</gallery> | |||
=Vehicle construction mode= | =Vehicle construction mode= | ||
Entity welding is also utilized for '''optimization of vehicles'''. Vehicles are by default spawned in '''construction mode''' which allows to add object to their structure. Once the vehicle is done, the construction mode has to be manually canceled and entities will get welded. | |||
Switching construction mode on / off is done via vehicle '''properties panel'''. | |||
<gallery> | |||
Image:Ylands-Editor-entity welding vehicles.png | |||
</gallery> | |||
---- | ---- | ||
{{Ylands scripting navbox}} | {{Ylands scripting navbox}} | ||
[[Category: Ylands: How To]] | |||
Revision as of 01:42, 24 August 2020
Overview
Entity welding is feature, which allows to merge multiple entities in to one. Entities welded together will have new, optimized collision envelope, which leads to better performance in game. Welding large structures consisting from hundreds of individual pieces is resource demanding proces and could take even several minutes to complete, but it is essential optimization tool.
Images below show comparison between welded and unwelded entity, improvement in this particular case is 62%. Note: These are not actual entity colors, but collision visualization.
Colliders before weld
Colliders after weld
Welding works similar as object grouping, but it is available only for compatible entities. Entity weld is new game object and is threatened in same manner as entity - it can be referenced in script or included in a groups. Weld also provides similar editing options as object group - it is possible to cancel the weld or edit welded entities on individual level.
Note:
- type /collidercount to console to see total collider count in the scene.
Welding entities
When valid entities are selected, Weld entities option in object selection menu will become available. This button will initiate the merge process and create Entity weld. If incompatible entities are also selected, they will be automatically excluded from the welding process.
Entities that cannot be welded
- Pickable entities (can be disabled)
- Entities with interactions (e.g chairs, doors)
- Entities with animations (e.g trees, grass)
- Entities in labels
- Entities referenced in script
Example
Entities to weld
Weld + excluded entities
Global welding
It is also possible to perform global welding, which will divide the world in small chunks and will merge all eligible objects in each chunks in to one weld. Global welding can be performed via Export -> Optimize in editor main menu. Depending on the size of map and number of used objects, this process can take up to several minutes or even hours. Optimized scenario then has to be saved in order to preserve newly created entity welds.
Vehicle construction mode
Entity welding is also utilized for optimization of vehicles. Vehicles are by default spawned in construction mode which allows to add object to their structure. Once the vehicle is done, the construction mode has to be manually canceled and entities will get welded.
Switching construction mode on / off is done via vehicle properties panel.
