Differences

This shows you the differences between two versions of the page.

Link to this comparison view

wheelconfig [2017/05/24 14:27] (current)
Line 1: Line 1:
 +====== Vehicle Customisation Configurations (Wheels) ======  ​
  
 +Game Version: ​     \\
 +Programs required: ​
 +----
 +
 +[[modding_tutorials|Modding Index]] | [[vehicle_modding|Vehicle Tutorials]]
 +
 +----
 +
 +===== Tutorial Intro =====
 +
 +
 +
 +===== Prep Work =====
 +
 +
 +
 +===== Full Details =====
 +
 +Well this is an idea I've had for a bit, I've no idea if it will be any use to people or not but it should make some parts of GIANTS'​ new vehicle customisations a bit clearer. I have started with two of the configurations and have tried to explain them to my upmost. Some of it relies on reasonable GIANTS Editor knowledge and some relies on initiative, however any questions then I'm sure they will be answered on either this tutorial if they'​re specific to it or in the forum if it is a general issue with vehicle customisation.
 +
 +This tutorial will be added to over time with more of the configurations when I have time to look through them all, because there seem to be a fair few  :D. Any improvements on things I have got wrong or have missed will also be appreciated.
 +
 +Finally, I'm sorry if I've posted this in the wrong place and if it needs to be moved then feel free.
 +
 +The text in bold is the function of the parameters, although I appreciate that this might not be extremely clear to everyone'​s eyes. The code is organised as it is in the XMLs yet is split up to make the parameters in each line clearer to see.
 +
 +[hr]
 +
 +[size=14pt]Wheel options:​[/​size]
 +
 +[code]
 +<​wheelConfigurations>​
 +<​wheelConfiguration name=""​ price=""​ icon=""​ >
 +[/code]
 +
 +[color=green]name[/​color]="​$l10n_configuration_valueDefault"​
 +            "​$l10n_configuration_valueWheelBroad"​
 +            "​$l10n_configuration_valueCrawler"​
 +            "​$l10n_configuration_valueWheelWeights"​
 +            "​$l10n_configuration_valueTwinWheelsNarrow"​
 +            "​$l10n_configuration_valueWheelNarrow"​
 +            "​$l10n_configuration_valueTwinWheelsBack"​
 +            "​$l10n_configuration_valueTwinWheelsAll"​
 +
 +[color=green]icon[/​color]="​$dataS2/​menu/​hud/​configurations/​config_wheel_broad.png"​
 +         "​$dataS2/​menu/​hud/​configurations/​config_wheel_track.png"​
 +         "​$dataS2/​menu/​hud/​configurations/​config_wheel_weight.png"​
 +         "​$dataS2/​menu/​hud/​configurations/​config_wheel_thinTwin.png"​
 +         "​$dataS2/​menu/​hud/​configurations/​config_wheel_thin.png"​
 +         "​$dataS2/​menu/​hud/​configurations/​config_wheel_twin.png"​
 +
 +[code]<​wheels autoRotateBackSpeed=""​ ackermannSteeringIndex=""​ >[/code]
 +
 +[color=green]autoRotateBackSpeed[/​color]="​[b]Speed the wheel returns to it's standard rotation[/​b]"​
 +[color=green]ackermannSteeringIndex[/​color]="​[b]Used on wide wheels as a rotation offset (Usually 2)[/​b]"​
 +
 +[code]<​wheel rotSpeed=""​ restLoad=""​ repr=""​ driveNode=""​ forcePointRatio=""​ filename=""​ isLeft=""​                       initialCompression=""​ suspTravel=""​ spring=""​ damper=""​ hasTireTracks=""​ hasParticles=""​ fenderNode=""​ fenderRotMax=""​ />
 +[/code]
 +[code]                
 +<wheel rotSpeed=""​ restLoad=""​ repr=""​                           forcePointRatio=""​ filename=""​ isLeft=""​ configIndex=""​ initialCompression=""​ suspTravel=""​ spring=""​ damper=""​ hasTireTracks=""​ hasParticles=""​ />​[/​code]
 +
 +[color=green]rotSpeed[/​color]="​[b]Speed of wheel rotation (Usually 0-1)[/​b]"​
 +[color=green]repr[/​color]="​[b]Node to the wheels main joint transform group[/​b]"​
 +[color=green]driveNode[/​color]="​[b]Child of the wheels main transform for rotating wheels only[/​b]"​
 +[color=green]filename[/​color]="​[b]file path to the XML of the desired wheel from ingame[/​b]"​
 +[color=green]isLeft[/​color]="​[b]Boolean defining the location of the wheel[/​b]"​
 +[color=green]initialCompression[/​color]="​[b]The standard compression of the tyre[/​b]"​
 +[color=green]suspTravel[/​color]="​[b]The movement limit available in the tire when suspension is acting[/​b]"​
 +[color=green]spring[/​color]="​[b]Rebound of the wheel when suspension is acting[/​b]"​
 +[color=green]damper[/​color]="​[b]Sets the smoothness of the vehicles movement by allowing the tyres to suspend the vehicle[/​b]"​
 +[color=green]hasTireTracks[/​color]="​[b]Boolean that decides whether the tyre creates tracks on the ground following it's path or not[/​b]"​
 +[color=green]hasParticles[/​color]="​[b]Boolean defining if the tyre creates particles over certain terrain types[/​b]"​
 +[color=green]fenderNode[/​color]="​[b]Node of the wheel'​s rotating fender[/​b]"​
 +[color=green]fenderRotMax/​fenderRotMin[/​color]="​[b]Limits the rotation of the fender against the rotation of the wheel to avoid conflict with the tractor for the left/right wheel respectively[/​b]"​
 +
 +[code]</​wheels>​[/​code]
 +[code] <​objectChange node=""​ translationActive=""​ />​[/​code]
 +
 +[color=green]node[/​color]="​[b]Node of the collison of the wheel that is adjusted to suit wider wheels[/​rb]"​
 +translationActive="​[b]X Y Z change in translation on each axis to adjust the position of the dynamically loaded tyres if wider than standard[/​b]
 +
 +[code]</​wheelConfiguration>​[/​code]
 +[code]</​wheelConfigurations>​[/​code]
 +
 +[hr]
 +
 +[size=14pt]Rim Options:​[/​size]
 +
 +[code]<​rimColorConfigurations useDefaultColors=""​ price=""​ icon="">​[/​code]
 +[code]<​rimColorConfiguration color=""​ />​[/​code]
 +
 +[color=green]useDefaultColours[/​color]="​[b]Boolean to state if the mod uses the colours on the wheel'​s texture as default or not[/​b]"​
 +[color=green]icon[/​color]="​$dataS2/​menu/​hud/​configurations/​config_rimColor.png"​
 +[color=green]colour[/​color]="​[b]Uses values (I'm not sure what type of colour values these are) to define the colour of the individual configuration[/​b]"​
 +[i]Note that the price and icon attributes can be defined in each individual configuration or the set of configurations[/​i]
 +
 +[code]<​colorNode node=""​ />​[/​code]
 +
 +[color=green]node[/​color]="​[b]The node of the wheels transform in the I3D[/​b]"​
 +
 +[code]</​rimColorConfigurations>​[/​code]
 +
 +[hr]
 +
 +[size=14pt]Input Attacher Options:​[/​size]
 +
 +[code]<​inputAttacherJointConfigurations>​
 +        <​inputAttacherJointConfiguration name=""​ price="">​[/​code]
 +
 +[color=green]name[/​color]="​$l10n_configuration_inputAttacher3Point"​
 +            "​$l10n_configuration_inputAttacherWheelLoader"​
 +            "​$l10n_configuration_inputAttacherSkidSteer"​
 +            "​$l10n_configuration_inputAttacherFrontLoader"​
 +            "​$l10n_configuration_inputAttacherTelehandler"​
 +
 +[code]<​inputAttacherJoint index=""​ topReferenceNode=""​ jointType=""​ isControllable=""​ lowerRotLimitScale=""​ lowerDistanceToGround=""​ upperRotLimitScale=""​ lowerTransLimitScale=""​ upperTransLimitScale=""​ upperDistanceToGround=""​ upperRotationOffset=""​ />​[/​code]
 +
 +[color=green]index[/​color]="​[b]Index of the attacher joint[/​b]"​
 +[color=green]topReferenceNode[/​color]="​[b]Reference to the top node of the attacher joint[/​b]"​ [i]3-Point Only[/i]
 +[color=green]jointType[/​color]="​implement"​
 +                  "​wheelLoader"​
 +                  "​skidSteer"​
 +                  "​frontLoader"​
 +                  "​telehandler"​
 +[color=green]isControllable[/​color]="​[b]Boolean deciding if the attacher type allows mouse control (mostly designed for 3-point implements that can't be moved otherwise[/​b]" ​
 +[color=green]lowerRotLimitScale[/​color]="​[b]X Y Z lowest limit on rotation(Mostly 0 0 0)[/​b]"​ [i]3-Point Onky[/i]
 +[color=green]lowerDistanceToGround[/​color]="​[b]Distance that the bottom attacher lowers from the lifted position***[/​b]"​ [i]3-Point Only[/i]
 +[color=green]upperRotLimitScale[/​color]="​[b]X Y Z highest limit on rotation (Mostly 0 0 0)[/​b]"​ [i]3-Point Only[/i]
 +[color=green]lowerTransLimitScale[/​color]="​[b]X Y Z lowest limit on the implement translation[/​b]"​ [i]3-Point Only[/i]
 +[color=green]upperTransLimitScale[/​color]="​[b]X Y Z highest limit on implement translation[/​b]"​ [i]3-Point Only[/i]
 +[color=green]upperDistanceToGround[/​color]="​[b]Distance of the attacher joint to the ground when lifted***[/​b]"​ [i]3-Point Only[/i]
 +[color=green]upperRotationOffset[/​color]="​[b]Offset placed on the rotation of the upper attacher[/​b]"​ [i]3-Point Only[/i]
 +
 +[i]Please note that I'm not positive on what all the parameters do but I've written what I can figure out. However they are all the same as any implement meaning I'm sure there is more information out there on them specifically[/​i]
 +
 +[code]<​objectChange node=""​ visibilityActive=""​  visibilityInactive=""/>​[/​code]
 +
 +[color=green]node[/​color]="​[b]Node of the model for the selected attacher joint[/​b]"​
 +[color=green]visibilityActive[/​color]="​[b]Boolean to decide if the object node sets the object to be visible or not[/​b]"​
 +[color=green]visibilityInactive[/​color]="​[b]Boolean to decide if the object node sets the object to be invisible or not[/​b]"​
 +
 +[code]</​inputAttacherJointConfiguration>​[/​code]
 +[code]</​inputAttacherJointConfigurations>​[/​code]
 +
 +[i]As a note, if the attacher type isn't a 3-Point attacher, the only parameters needed in the [color=red]<​inputAttacherJoint  />​[/​color] section are [color=green]index[/​color] and [color=green]jointType[/​color][/​i]
 +
 +[hr]
 +
 +[size=14pt]Front Loader Options:​[/​size]
 +
 +[code]<​frontloaderConfigurations>​
 +        <​frontloaderConfiguration name=""​ price=""​ >[/code]
 +
 +[color=green]name[/​color]="​$l10n_ui_no"​
 +            "​$l10n_ui_yes"​
 +
 +[code]<​objectChange node=""​ visibilityActive=""​ visibilityInactive=""/>​[/​code]
 +
 +[color=green]node[/​color]="​[b]The node of the front loader block[/​b]"​
 +[color=green]visibilityActive[/​color]="​[b]Boolean to set if the front loader block is visible or not[/​b]"​
 +[color=green]visibilityInactive[/​color]="​[b]Boolean setting if the object is invisible or not[/​b]"​
 +
 +[code]<​attacherJoint index=""​ jointType="​attachableFrontloader"​ upperRotation=""​ lowerRotation=""​ lowerTransLimit=""​ lowerRotLimit=""​ moveTime=""​ >[/code]
 +
 +[color=green]index[/​color]="​[b]The node of the front loader attacher joint[/​b]"​
 +[color=green]upperRotation[/​color]="​[b]X Y Z Set upper rotation of the attacher joint (Usually 0 0 0 )[/b]"
 +[color=green]lowerRotation[/​color]="​[b]X Y Z Set lower attacher joint rotation (Usually 0 0 0 )[/b]"
 +[color=green]lowerTransLimit[/​color]="​[b]X Y Z Smallest amount of translation with the attacher (Usually 0 0 0 )[/b]"
 +[color=green]lowerRotLimit[/​color]="​[b]X Y Z Sets a limit of the lowering rotation to avoid model collisions (Usually 0 0 0 )[/b]"
 +[color=green]moveTime[/​color]="​[b]Speed of the attacher joint rotation[/​b]"​
 +
 +[code]<​schema position="​0 0.4" rotation="​0"​ invertX="​true"​ />​[/​code]
 +[code] </​attacherJoint>​[/​code]
 +[code]</​frontloaderConfiguration>​[/​code]
 +[code]</​frontloaderConfigurations>​[/​code]
 +
 +[i]The general front loader setup involves having two configurations with a yes/no option which needs the objects involved setting on or off depending on which option is chosen[/i]
 +
 +[hr]
 +
 +[size=14pt]Design Options:​[/​size]
 +
 +[code]<​designConfigurations>​
 +                  <​designConfiguration name=""​ price=""​ icon="">​ [/code]
 +
 +[color=green]name[/​color]="​$l10n_configuration_valueDefault"​
 +            "​$l10n_[...]"​
 +
 +[i]This is a good point to introduce how you would add a custom design option, and it's fairly simple.[/i]
 +
 +This next section takes place in the Moddesc.xml
 +
 +--------------------
 +
 +[code]<​l10n>​ [/​code]
 +
 +[code]<​text name=""><​en></​en><​de></​de></​text>​[/​code]
 +
 +[color=green]name[/​color]="​[b]Name of the XML link to the vehicle.xml (the text that takes the place of the [...] section above)[/​b]"​
 +
 +[i]The sections following are the text that is displayed in the actual UI in store e.g if a tractor mod had multiple weights as a design option, the name=""​ section might have names like weight1,​weight2 ect. and the text tags would might have 800kg Weight, 1000kg Weight.[/i]
 +
 +[code] </​l10n>​[/​code]
 +
 +--------------------
 +
 +The following takes place back in the vehicle.xml
 +
 +[color=green]icon[/​color]="​[b]File path for the icon displayed in store to show what the option does[/​b]"​
 +
 +[code]<​objectChange node=""​ visibilityActive=""​ visibilityInactive=""/>​[/​code]
 +
 +[color=green]node[/​color]="​[b]Node for the object being added/​removed with the customisation[/​b]"​
 +[color=green]visibilityActive[/​color]="​[b]Boolean to state if the object is visible or not[/​b]"​
 +[color=green]visibilityInactive[/​color]="​[b]Boolean to define if the object is invisible or not[/​b]"​
 +
 +[code]</​designConfiguration>​ [/​code]
 +
 +[code]</​designConfigurations>​ [/​code]
 +
 +[hr]
 +
 +Thanks|Chocolatecake2001
 +
 +----
 +
 +Original Author: ​ Chocolatecake2001 | Date: October 31, 2016
 +        ​
 +[[modding_tutorials|Modding Index]] | [[vehicle_modding|Vehicle Tutorials]]\\
 +
 +{{:​fsukwiki.png?​nolink&​200 |}}