Tools - Sollumz/Sollumz GitHub Wiki

Note: The new wiki is at https://docs.sollumz.org/.

Accessing the tools

The tools menu can be found in the 3D view sidebar

General Tools

Views

These options allow you to hide various different Sollumz objects from the view with ease.

Debug Tools

Some updates may have caused the sollum type of objects in the scene to change. The Debug Hierarchy tool can fix this. Select the object you want to fix, choose the sollum type that the object should be from the dropdown, and click "Fix Hierarchy".

Ymap Tools

Here you can import/export .ymap.xml files. If you have objects in the scene that are entities of the imported YMAP, each of these objects will have its position set according to the YMAP. Under the Entity sub-panel, you can edit the properties of the selected entity (Drawable objects only). Exporting will take these entity properties from all the Drawables in the scene and place them in the exported .ymap.xml file.

Vertex Painter

This tool allows you to quickly paint all vertices of an object one color.

Drawable Tools

Create Shader

This tools allows you to create a GTA V shader material on the selected object(s) (must be a Geometry object). Simply select a shader and click "Create Shader Material". If you're not sure which shader to use and just want a basic image texture, choose the default shader. (note: The .ydr.xml file format only allows for one material per Geometry object, so if you export a model that has geometries with multiple materials, those geometries will be split up by each material in the exported file. This shouldn't be a problem for most people though.)

Create Drawable Objects

These operators allow you to create various different Drawable objects.

Create Sollumz Drawable will create an empty drawable if nothing is selected. If objects are selected, this operator will create a single Drawable with a Drawable Model for each selected object. When the Separate Objects option is ticked, it will create a Drawable for each selected object. The Use Names option determines whether or not to use the names of the selected objects in the newly created Drawable.

Static Collision Tools

Create Bounds

These operators allow you to create various different collision objects. These behave the same way as the Drawable creation tools.

Create Material

Much like the Create Shader tool for Drawables, this operator creates a collision material on the selected object(s). The collision material will determine how the collision behaves when interacted with in-game.

This only works on objects that have mesh data. The YBN format requires that each object has only one collision material. However, since Bound Poly Mesh is made up of Bound Poly Triangles, it can have multiple materials.

Flag Presets

Flag presets allow you to quickly set collision flags for a Bound Geometry or Bound GeometryBVH object. If you have made any flag presets that you think may be useful to others please share them and we may bundle them with Sollumz!

Save Flag Preset will save the current flags selection with the name provided. These files are stored in addons/Sollumz/ybn/flag_presets.xml.
Delete Flag Preset deletes the selected flag preset (be careful this cannot be undone!) and Apply Flags Preset applies the selected flag preset to the object.
Clear Collision Flags clears all selected flags from the object.