309
edits
Changes
Created page with "{{Note|This article is a work in progress and has yet to be reviewed by SCS staff. Some information may be incomplete or inaccurate.}} The '''physics_trailer_cable_data''' un..."
{{Note|This article is a work in progress and has yet to be reviewed by SCS staff. Some information may be incomplete or inaccurate.}}
The '''physics_trailer_cable_data''' unit class is used for defining a dynamic trailer cable connection between a vehicle and its trailer. Units of this type are typically nameless, and defined in-line with an '''[[Documentation/Engine/Units/accessory_addon_trailer_cables_data|accessory_addon_trailer_cables_data]]''' unit ''This unit type was added in 1.31.''
== Attributes ==
{|class="wikitable"
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Default Value
!Description
|-
|locator_prefix
|token
|
|The name of the locators on the vehicle and trailer that will be used to connect the cable.
|-
|rest_locator_prefix
|token
|
|The name of the locator on the vehicle that will be used as a rest position for the trailer end of the cable when no trailer is connected. If there is no rest locator, the cable will not be drawn unless there is a cable connected.
|-
|vehicle_plug_model
|string
|
|Path to the descriptor (.pmd) of the model to be used at the vehicle end of the cable. This model will be hooked up at, and oriented to, the locator defined in '''locator_prefix'''. If no model is defined, the cable will be hooked up directly to the locator on the vehicle.
|-
|vehicle_plug_model_variant
|token
|default
|The variant of the '''vehicle_plug_model''' to be used.
|-
|vehicle_plug_model_look
|token
|default
|The look of the '''vehicle_plug_model''' to be used.
|-
|vehicle_plug_model_offset
|float3
|(0.0, 0.0, 0.0)
|The offset (in local space) from the '''vehicle_plug_model''' origin at which the vehicle end of the cable will be attached.
|-
|trailer_plug_model
|string
|
|Path to the descriptor (.pmd) of the model to be used at the trailer end of the cable. This model will be hooked up at, and oriented to, the locator defined in '''locator_prefix''' when there is a trailer attached, or the locator defined in '''rest_locator_prefix''' when there is not a trailer attached. If no model is defined, the cable will be hooked up directly to the locator on the trailer.
|-
|trailer_plug_model_variant
|token
|default
|The variant of the '''trailer_plug_model''' to be used.
|-
|trailer_plug_model_look
|token
|default
|The look of the '''trailer_plug_model''' to be used.
|-
|trailer_plug_model_offset
|float3
|(0.0, 0.0, 0.0)
|The offset (in local space) from the '''trailer_plug_model''' origin at which the trailer end of the cable will be attached.
|-
|ring_count
|int
|
|The number of rings in the spiral portion of the cable. (Minimum 2)
|-
|ring_resolution
|int
|
|The number of sides each ring has.
|-
|diameter
|float
|
|Diameter of the spiral portion of the cable.
|-
|width
|float
|
|Diameter of the cable itself.
|-
|material
|string
|"/material/ropes/cable_white.mat"
|The material used for rendering the cable.
|-
|color
|float3
|(0.5, 0.5, 0.5)
|The vertex color (in linear colorspace) applied to the cable model.
|}
The '''physics_trailer_cable_data''' unit class is used for defining a dynamic trailer cable connection between a vehicle and its trailer. Units of this type are typically nameless, and defined in-line with an '''[[Documentation/Engine/Units/accessory_addon_trailer_cables_data|accessory_addon_trailer_cables_data]]''' unit ''This unit type was added in 1.31.''
== Attributes ==
{|class="wikitable"
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Default Value
!Description
|-
|locator_prefix
|token
|
|The name of the locators on the vehicle and trailer that will be used to connect the cable.
|-
|rest_locator_prefix
|token
|
|The name of the locator on the vehicle that will be used as a rest position for the trailer end of the cable when no trailer is connected. If there is no rest locator, the cable will not be drawn unless there is a cable connected.
|-
|vehicle_plug_model
|string
|
|Path to the descriptor (.pmd) of the model to be used at the vehicle end of the cable. This model will be hooked up at, and oriented to, the locator defined in '''locator_prefix'''. If no model is defined, the cable will be hooked up directly to the locator on the vehicle.
|-
|vehicle_plug_model_variant
|token
|default
|The variant of the '''vehicle_plug_model''' to be used.
|-
|vehicle_plug_model_look
|token
|default
|The look of the '''vehicle_plug_model''' to be used.
|-
|vehicle_plug_model_offset
|float3
|(0.0, 0.0, 0.0)
|The offset (in local space) from the '''vehicle_plug_model''' origin at which the vehicle end of the cable will be attached.
|-
|trailer_plug_model
|string
|
|Path to the descriptor (.pmd) of the model to be used at the trailer end of the cable. This model will be hooked up at, and oriented to, the locator defined in '''locator_prefix''' when there is a trailer attached, or the locator defined in '''rest_locator_prefix''' when there is not a trailer attached. If no model is defined, the cable will be hooked up directly to the locator on the trailer.
|-
|trailer_plug_model_variant
|token
|default
|The variant of the '''trailer_plug_model''' to be used.
|-
|trailer_plug_model_look
|token
|default
|The look of the '''trailer_plug_model''' to be used.
|-
|trailer_plug_model_offset
|float3
|(0.0, 0.0, 0.0)
|The offset (in local space) from the '''trailer_plug_model''' origin at which the trailer end of the cable will be attached.
|-
|ring_count
|int
|
|The number of rings in the spiral portion of the cable. (Minimum 2)
|-
|ring_resolution
|int
|
|The number of sides each ring has.
|-
|diameter
|float
|
|Diameter of the spiral portion of the cable.
|-
|width
|float
|
|Diameter of the cable itself.
|-
|material
|string
|"/material/ropes/cable_white.mat"
|The material used for rendering the cable.
|-
|color
|float3
|(0.5, 0.5, 0.5)
|The vertex color (in linear colorspace) applied to the cable model.
|}