Transform Component: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
RBDev (talk | contribs)
No edit summary
Added section on limits
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
The Transform Component is the base component of all GameObjects in a mod.  
[[File:TransformComponentExample.gif|thumb|right|600px|Notice how the transform values change when the object is moved, rotated and scaled.]]
The Transform Component is the base component of every [[Gameobject]] in a mod. It defines the position, orientation and scale of the gameobject. These values are relative to the parent gameobject in the hierarchy, or from the world origin if the gameobject doesn't have a parent.
 
== Component Settings ==
== Component Settings ==
[[File:Transform component box.png|frame|none]]
{| class="wikitable"
{| class="wikitable"
|-
|-
! Property !! Description
! Property !! Description
|-
|-
|'''Position''' || The position of the .
|'''Position''' || The position of the GameObject relative to its parent. The three values from left to right represent a position on the x-axis, y-axis and z-axis respectively.
|-
| '''Color''' || The color of the shading applied by the light source.
|-
| '''Range''' || The distance the light source will effect objects (for directional lights this has no effect).
|-
| '''Intensity''' || The brightness of the light source.
|-
| '''Shadows''' || Determines if this light source will cast shadows and whether they will have a soft or hard edge).
|-
| style="padding-left: 2em;" | ''None'' || Light does not produce shadows.
|-
|-
| style="padding-left: 2em;" | ''Hard'' || Light produces shadows with hard, crisp edges.
| '''Rotation''' || The rotation of the GameObject relative to its parent. The three values from left to right represent a rotation around the x-axis, y-axis and z-axis respectively. These values are in degrees.
|-
|-
| style="padding-left: 2em;" | ''Soft'' || Light produces shadows with soft, blurred edges.
| '''Scale''' || The relative scale of the GameObject. The three values from left to right represent relative scaling along the GameObject's x-axis, y-axis and z-axis respectively.
|}
|}


==Limits==
* The position of a transform cannot be greater than 1000 units along any axis in any direction.
* Scale cannot be 0 or negative, and cannot be greater than 1000x.


 
[[Category:Components]]
Position values are measured in units, which can be thought of as metres or yards.
Rotation values are measured in Degrees around whichever axis

Latest revision as of 02:04, 16 December 2022

Notice how the transform values change when the object is moved, rotated and scaled.

The Transform Component is the base component of every Gameobject in a mod. It defines the position, orientation and scale of the gameobject. These values are relative to the parent gameobject in the hierarchy, or from the world origin if the gameobject doesn't have a parent.

Component Settings

Property Description
Position The position of the GameObject relative to its parent. The three values from left to right represent a position on the x-axis, y-axis and z-axis respectively.
Rotation The rotation of the GameObject relative to its parent. The three values from left to right represent a rotation around the x-axis, y-axis and z-axis respectively. These values are in degrees.
Scale The relative scale of the GameObject. The three values from left to right represent relative scaling along the GameObject's x-axis, y-axis and z-axis respectively.

Limits

  • The position of a transform cannot be greater than 1000 units along any axis in any direction.
  • Scale cannot be 0 or negative, and cannot be greater than 1000x.