Difference between revisions of "Documentation/Tools/SCS Blender Tools/Part system"

From SCS Modding Wiki
Jump to navigation Jump to search
(Major edit: Started missing section 'Predefined Part Names', wikified important terms, added buttons and icons for better visual identification)
Line 1: Line 1:
−
Parts provides a kind of grouping system for Model and Locator objects. It is usually used for defining of Variants (see the chapter “Variant System” below) and also in special cases, when we need to define a part of the geometry, that has to have a different treating then the rest of the model (see the chapter “Predefined Part Names”).
+
'''Parts''' provide a kind of grouping system for Model and [[Documentation/Tools/SCS_Blender_Tools/Locators|Locator]] objects. They are usually used in defining [[Documentation/Tools/SCS_Blender_Tools/Variant_system|Variants]] but, in [[#predefined_part_names|special cases]], they are also used to define parts of the geometry that will be treated differently than the rest of the model.
  
−
Every object in a scene belongs to some Part. Even in case when we don't need to use Parts, there is always a Part name assigned to every object in a scene. The default name is “defaultpart”, but it can be changed any time. If the active object is not parented to any SCS Root Object, then it is not possible to set the Part name for such object.
+
Every object in a scene belongs to some Part. Even in cases when we don't need to use Parts, there is always a Part name assigned to every object in a scene. The default name is “defaultpart”, but it can be changed any time. If the active object is not parented to any [[Documentation/Tools/SCS_Blender_Tools/Terminology_and_basics#SCS_Root_Object|SCS Root Object]], then it is not possible to set the Part name for that object.
−
 
 
−
[[File:SCS_Tools_Object_Specials_-_Parts_05.png]]
 
  
 
== Part list ==
 
== Part list ==
−
 
+
[[Image:SCS_Tools_Object_Specials_-_Parts_05.png|right]]
−
Part list is held on every SCS Root Object and it contains all the Part names, which are used within this SCS Game Object.
+
There is a '''Part List''' for each SCS Root Object which contains the Part names used within its respective SCS Game Object.
  
 
=== Add, Remove, Rename Parts ===
 
=== Add, Remove, Rename Parts ===
  
−
You can '''''Add''''' or '''''Remove''''' names from the Part list using the buttons on the right side of the list. The lowest button here is a '''''Remove Unused''''' button, which will automatically remove any unused Part names. To '''''Rename''''' the existing Part just double click the item in the list and type a new name.
+
You can {{Blender_Button|[[File:Blend_icon_zoomin.png]]}} '''''Add''''' or {{Blender_Button|[[File:Blend_icon_zoomout.png]]}} '''''Remove''''' names from the Part list using the buttons on the right side of the list. The lowest button here is a {{Blender_Button|[[File:Blend_icon_file_refresh.png]]}} '''''Remove Unused''''' button, which will automatically remove any unused Part names. To '''''Rename''''' the existing Part just double click the item in the list and type a new name.
  
 
=== Additional list tools ===
 
=== Additional list tools ===
  
−
There are also some additional tools integrated for each item in Part list and can be used for easy selection/deselection (arrow icon) or hiding/showing (eye icon) of particular Parts. It works like a switches, so if it is pressed repeatedly it will select and deselect or hide and show all the Part items. With '''''Shift''''' pressed it will always add to the existing selection or always show the Part items and with '''''Ctrl''''' it will always subtract from existing selection or always hide the Part items.
+
There are also some additional tools integrated for each item in the Part list which can be used for easy selection/deselection (arrow icon [[File:Blend_icon_restrict_select_off.png]]) or hiding/showing (eye icon [[File:Blend_icon_restrict_view_off.png]]) of particular Parts. It works like a switches, so if it is pressed repeatedly it will select and deselect or hide and show all the Part items. With {{Key_press|Shift}} pressed it will always add to the existing selection or always show the Part items and with {{Key_press|Ctrl}} it will always subtract from existing selection or always hide the Part items.
  
−
== Item-selection tools ==
+
=== Item-selection tools ===
  
 
If the active object is Model, Model Locator or Collision Locator object additional buttons appear.
 
If the active object is Model, Model Locator or Collision Locator object additional buttons appear.
  
−
=== Assign ===
+
{{Blender_Button|Assign}} Assigns currently selected Part name to selected object(s). For multiple selections, all selected objects must belong to the same SCS Root Object.
 +
 
 +
{{Blender_Button|Select}} Selects all Models, Model Locators and Collision Locators within active SCS Game Object which uses the same Part name.
 +
 
 +
{{Blender_Button|Deselect}} Deselects all Models, Model Locators and Collision Locators within active SCS Game Object which uses the same Part name.
 +
 
 +
== Predefined Part Names ==
  
−
Assigns currently selected Part name to active object.
+
Some special behaviors are applied in-game to Parts with certain predefined names, based on the type of object.
  
−
=== Select ===
+
=== Trucks ===
 +
There are currently no predefined part names used for trucks.
  
−
Select all the Models, Model Locators and Collision Locators within active SCS Game Object which uses the same Part name.
+
=== Trailers ===
 +
{| class="wikitable"
 +
!Name
 +
!Behavior
 +
!Notes
 +
|-
 +
|brace_on
 +
|Lowered landing gear (static)<br />Visible when trailer is detached, and before landing gear is raised when attached.
 +
|rowspan="2"|The ''brace_on'' part should be active for all variants of the trailer model, and the ''brace_off'' part should be inactive.
  
−
=== Deselect ===
+
For trailers with animated landing gear, both ''brace_on'' and ''brace_off'' are invisible during the landing gear animation. For best results, these parts should visually match the start and end keyframes of the landing gear animation.
 +
|-
 +
|brace_off
 +
|Raised landing gear (static)<br />Visible when trailer is attached, after landing gear is raised.
 +
|}
  
−
Deselect all the Models, Model Locators and Collision Locators within active SCS Game Object which uses the same Part name.
+
=== Map Objects ===
 +
*viz
 +
:Used for the visible part of the model.
 +
*col
 +
:Used for the collision geometry.

Revision as of 01:17, 13 September 2016

Parts provide a kind of grouping system for Model and Locator objects. They are usually used in defining Variants but, in special cases, they are also used to define parts of the geometry that will be treated differently than the rest of the model.

Every object in a scene belongs to some Part. Even in cases when we don't need to use Parts, there is always a Part name assigned to every object in a scene. The default name is “defaultpart”, but it can be changed any time. If the active object is not parented to any SCS Root Object, then it is not possible to set the Part name for that object.

Part list

SCS Tools Object Specials - Parts 05.png

There is a Part List for each SCS Root Object which contains the Part names used within its respective SCS Game Object.

Add, Remove, Rename Parts

You can Blend icon zoomin.png Add or Blend icon zoomout.png Remove names from the Part list using the buttons on the right side of the list. The lowest button here is a Blend icon file refresh.png Remove Unused button, which will automatically remove any unused Part names. To Rename the existing Part just double click the item in the list and type a new name.

Additional list tools

There are also some additional tools integrated for each item in the Part list which can be used for easy selection/deselection (arrow icon Blend icon restrict select off.png) or hiding/showing (eye icon Blend icon restrict view off.png) of particular Parts. It works like a switches, so if it is pressed repeatedly it will select and deselect or hide and show all the Part items. With ⇧ Shift pressed it will always add to the existing selection or always show the Part items and with Ctrl it will always subtract from existing selection or always hide the Part items.

Item-selection tools

If the active object is Model, Model Locator or Collision Locator object additional buttons appear.

Assign Assigns currently selected Part name to selected object(s). For multiple selections, all selected objects must belong to the same SCS Root Object.

Select Selects all Models, Model Locators and Collision Locators within active SCS Game Object which uses the same Part name.

Deselect Deselects all Models, Model Locators and Collision Locators within active SCS Game Object which uses the same Part name.

Predefined Part Names

Some special behaviors are applied in-game to Parts with certain predefined names, based on the type of object.

Trucks

There are currently no predefined part names used for trucks.

Trailers

Name Behavior Notes
brace_on Lowered landing gear (static)
Visible when trailer is detached, and before landing gear is raised when attached. 		The brace_on part should be active for all variants of the trailer model, and the brace_off part should be inactive.

For trailers with animated landing gear, both brace_on and brace_off are invisible during the landing gear animation. For best results, these parts should visually match the start and end keyframes of the landing gear animation.

brace_off Raised landing gear (static)
Visible when trailer is attached, after landing gear is raised.

Map Objects

  • viz
Used for the visible part of the model.
  • col
Used for the collision geometry.
Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Tools/SCS_Blender_Tools/Part_system&oldid=2789"