Creates a physical area with a primitive shape with custom gravity/buoyancy settings.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Area Settings |
| ||||||||||||
| Shape properties | Based on the Type selection, following options might appear on the panel:
| ||||||||||||
| Buoyancy Parameters |
| ||||||||||||
| Uniform | Flow and/or gravity is uniform rather than based on the position relative to the shape. | ||||||||||||
| Falloff Start | For non-uniform shapes, start of falloff (1 = shape boundary). |
Adds a physical box part to the physics only (without any StatObj). It still uses an entity slot
These colliders will not be rendered (except as helpers when the entity is selected in the editor), which can be desirable in some cases, such as ragdoll actors, invisible walls, or general collision adjustments.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Box Collider Settings |
| ||||||||||||
| Physics Settings |
|
Adds a physical capsule part to the physics only (without any StatObj). It still uses an entity slot.
These colliders will not be rendered (except as helpers when the entity is selected in the editor), which can be desirable in some cases, such as ragdoll actors, invisible walls, or general collision adjustments.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Capsule Collider Settings |
| ||||||||||||
| Physics Settings |
|
Functionality for a standard FPS / TPS style walking character.
| Property | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Character Controller Setting |
| ||||||||||||||||||||
| Physics |
| ||||||||||||||||||||
| Movement |
|
Physicalizes mesh as cloth/soft object.
Property | Description |
|---|---|
File | Determines the CGF to load. |
Material | Specifies the override material for the selected object. |
Cast Shadows | Sets whether the cloth will cast shadows. |
Mass | Mass of the cloth object (only useful for lighter than air closed objects). |
Density | Density of cloth's vertices (only affects floating in water). Unlike rigid bodies, cloth can have independent mass and density settings. |
Thickness | Used for collision detection. Every cloth vertex is surrounded by a colliding sphere with this radius. |
Mass Decay | Sets by how much vertex mass decreases at cloth's free ends compared to attached ones. Higher values improve solver and stretch enforcement quality, but it should be 0 for unattached cloth (such as pressurized). |
Friction | Friction at collision points. |
Air Resistance | Sets how strongly cloth is affected by the wind. |
Wind | Extra wind added to this cloth, on top of the global/physical areas. |
Wind Variance | Adds a random variance to the wind to make the cloth more flappy. |
Pressure | Internal pressure for closed cloth. |
Density Inside | Density of the medium inside the cloth. Can be used to adjust buoyancy, by having cloth objects filled with lighter-than-air mediums for instance (i.e. <1 density). Set to -1 to assume the same density as outside. |
| Impulse Scale | Scales hit impulses applied to the cloth (to avoid excessive reaction) |
Explosion Scale | Explosion impulses applied to the cloth (to avoid excessive reaction). This lets you have visible deformations from bullet impacts, but without vastly distorting the object too far with explosions. |
Simulation Parameters | |
Maximum Time Step | The largest time step that the entity can make before splitting. Smaller time steps increase the stability (can be required for long and thin objects, for instance), but are more expensive. |
Sleep Speed | An object is considered sleeping if its kinetic energy falls below a limit over several frames. This option defines that limit. The limit is proportional to Sleep Speed2. |
Damping | A cheaper alternative/addition to water resistance (applies uniform damping when in water). |
Hardness | Strength of connections between cloth's vertices. |
Max Iters | Amount of iterations to solve cloth's constraints (affects the cloth solver speed). |
Accuracy | Accuracy (allowed velocity error per frame) of the cloth solver. |
Max Stretch | Maximum allowed streching before positional enforcement is activated, in fractions of 1 (i.e. 0.05=5%). Smaller values to be used to remove stretching even with low Max Iters. It's a cheaper, but less physically accurate way. |
Bend Stiffness | Stiffness against bending - smaller values indicate less stiffness, larger values indicate stronger stiffness. Set to 0.0 to disable. |
Shear Stiffness | Strength against shearing - smaller values indicate less stiffness, larger values indicate stronger stiffness. Set to 0.0 to disable. |
Terrain Collisions | Enables collisions with the main terrain. |
Static Collisions | Enables collisions with static objects. |
Dynamic Collisions | Enables collisions with 'normal' physical object, i.e. rigid bodies, ragdolls, vehicles. |
Player Collisions | Enables collisions with legacy-style players (PE_LIVING). |
Adds a physical cylinder part to the physics only (without any StatObj). It still uses an entity slot.
These colliders will not be rendered (except as helpers when the entity is selected in the editor), which can be desirable in some cases, such as ragdoll actors, invisible walls, or general collision adjustments.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Cylinder Collider Settings |
| ||||||||||||
| Physics Settings |
|
Local Grid allows entities to be attached to larger hosts and be physically simulated within its local environment at the same time. An interior of a moving train or a spaceship are some of the examples where a Local Grid can be used to define a local environment.
More related information can be found on the Local Simulation Grids Technical Documentation page.
| Property | Description |
|---|---|
| Number Of Cells X | Number of cells that appear on the X axis. |
| Number Of Cells Y | Number of cells that appear on the Y axis. |
| Cell Size | Each field in this option defines the size of the cells on the X and Y axes respectively. |
| Height | Sets the height of the grid area. |
| Acceleration Threshold | Minimal host acceleration that is applied to objects inside the grid. |
Physicalizes the entity as a particle.
| Property | Description |
|---|---|
| Mass | Mass of the entity in kg. |
| Size | 'Size' in the direction of movement. If the particle is imagined as a sphere, 'size' is its diameter. |
| Thickness | Size along the normal when lying (can be different from size in the direction of movement) |
| Normal | Direction in the entity space that gets aligned with the surface normal when lying. |
| Roll Axis | Roll axis in the entity space. |
| Thrust | Acceleration in the direction movement. |
| Lift | Acceleration along the entity 'up' direction. |
| Gravity Scale | Particle's acceleration due to gravity = world gravity * this scale. A value of 0 will disable gravity completely, while a value of 1 means full gravity acceleration. |
| Water Gravity Scale | World gravity scaling coefficient when in water. |
| Air Resistance Scale | Scale to the global air resistance coefficient. |
| Water Resistance Scale | Scale to the global water resistance coefficient. |
| Bounce Speed Threshold | Minimal approach velocity (along the normal) that results in a bounce. |
| Sleep Threshold | Sends the particle to sleep if its speed falls below this threshold. |
| Awake | By default, the object is in a sleep mode so that it doesn't use any resources from the physics engine until it is required to do so. You can make the object to be "awake" by default when the game starts by checking this parameter. |
| Network Synced | Syncs the physical entity over the network and keeps it in sync with the server. |
| Send Collision Signal | Whether or not this component should listen for collisions to generate a signal. |
| Traceable | Particle is registered in the entity grid and can be seen by raytracing end entities-in-box queries. |
| Single Contact | Stops the particle after its first contact. |
| Constant Orientation | The particle never changes rotation on its own. |
| No Roll | The particle slides on the ground instead of rolling (which also triggers ground alignment along 'normal'). |
| No Spin | The particle doesn't spin when flying. |
| No Path Alignment | The particle doesn't align its (0,1,0) axis with the movement direction. |
| No Self Collisions | The particle doesn't collide with other particles with the same flag. |
| No Impulse | The particle doesn't add impulse on contact. |
| Surface Type | The particle's surface type (used for bounciness, friction, and particle effects). |
Physicalizes a single animated mesh or advanced animation component as a ragdoll, or a set of static meshes as an articulation.
| Property | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Ragdoll Settings |
| ||||||||
| Buoyancy Parameters | Fluid behavior related to this entity.
| ||||||||
| Simulation Parameters | Parameters related to the simulation of this entity.
| ||||||||
| Stiffness | If >0, allows ragdoll to play animations by applying torques at joints. | ||||||||
| Extra Stiff Mode | Much more stable with high stiffness values, but uses the same stiffness for playing animation and enforcing locked axes/limits. |
Physicalizes the entity as a rigidbody or a static (depending on the type). Adds mesh components and primitive collider components as parts. Note that those components alone will not physicalize the entity, they can only add parts to an entity that is physicalized through other means, such as RigidBody component.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Rigidbody Settings |
| ||||||||||||
| Buoyancy Parameters | Physical properties related to the behavior of this entity while submerged in fluid.
| ||||||||||||
| Simulation Parameters | Parameters that can be used to adjust the simulation of this entity.
|
Physicalizes the entity as PE_WALKING_RIGID, which is a suggested replacement for PE_LIVING. It has the same sweep-based main geometry movement, customizable set of ground sampling rays (as opposed to PE_LIVING fixed one at the center), and it's derived from PE_RIGID, meaning that it can seamlessly interact with other physicalized objects (the original PE_LIVINGs are simulated independently from normal physicalized objects, and thus their interactions are not as immediate and responsive). It naturally uses all geometries that were added to the entity, same as a RigidBody would (cgf's, physical colliders).
| Setting | Description |
|---|---|
| Friction | Friction of the sampling (leg) ray contacts that's used when the actor is not moving. Useful for standing on slopes (friction 1 can hold an object on a 45 degrees slope). |
| Minimal Ground Mass | Minimum mass that the objects must have to collide with the sampling rays (can be used to avoid standing on small debris pieces or props). |
| Legs Stiffness | Defines how strongly the character tries to restore fully upright position if leg ray contacts are compressed. |
| Skeleton Stiffness | Defines stiffness the attached alive skeleton of animated mesh components. |
Adds a physical sphere part to the physics only (without any StatObj). It still uses an entity slot.
These colliders will not be rendered (except as helpers when the entity is selected in the editor), which can be desirable in some cases, such as ragdoll actors, invisible walls, or general collision adjustments.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sphere Collider Settings |
| ||||||||||||
| Physics Settings |
|
The Thruster component is basically a way to add constant force to a physicalized object. It adds the force set in Constant Thrust along the component’s z axis, at the component’s origin.
| Setting | Description |
|---|---|
| Constant | True if force is enabled. |
| Constant Thrust | Force that is applied. It's applied at the component's origin and the vector is in the entity space. |
Creates physicalized hand objects and allows holding other physicalized objects with VR controllers by physically constraining them to "hands".
| Setting | Description |
|---|---|
| Left Hand Model | Model to use for the left hand. It it has physics, it will physically affect other physicalized objects when moving. |
| Right Hand Model | Same for the right hand. |
| Release On Hold Release | Whether to release the object when the key used to hold is released |
Physicalizes the entity as PE_WHEELEDVEHICLE (a rigidbody-derived wheeled vehicle).
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Engine Parameters |
| ||||||||||||
| Gear Parameters |
| ||||||||||||
| Send Collision Signal | Whether to listen to and report collision events. |
This components attaches itself to a physicalized water volume on game start and allows changing some of its parameters dynamically.
This is a very simple and "technical" component. The main way to set up water volumes is via the corresponding built-in editor object. That object is not itself an entity, thus no components can be attached to it directly, but the water volume component can "associate" itself with it by sampling the physics environment in the specified radius, and then be used to change some of the water volume’s properties (such as the total volume) via component functions.
| Property | Description |
|---|---|
| Attachment Distance | Distance around the component's origin that gets sampled for water volume attachment. |
Adds a cylindrical wheel geometry with a suspension to the vehicle. The top of the suspension spring is the component's origin.
| Property | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Transform |
| ||||||||||||||||||||||||||
| Physics Settings | Physical properties for the object, only used if a simple physics or character controller is applied to the entity.
|