SCRIPTING API / Physics / Buoyancy

Buoyancy

Script access to an entity's Buoyancy: how a rigid body floats on the ocean or a water body.

Kindclass

NamespaceKroys.EngineScripting

Members61

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example Buoyancy.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class Buoyancy

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Buoyancy component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the Buoyancy component's Enabled value of the entity.

methodstatic

#public static void SetEnabled(Entity e, bool value)

Sets the Buoyancy component's Enabled value on the entity.

methodstatic

#public static bool IsAutoFitColliderEnabled(Entity e)

Reads the Buoyancy component's Auto Fit Collider Enabled value of the entity.

methodstatic

#public static void SetAutoFitCollider(Entity e, bool value)

Sets the Buoyancy component's Auto Fit Collider value on the entity.

methodstatic

#public static bool IsDebugDrawEnabled(Entity e)

Reads the Buoyancy component's Debug Draw Enabled value of the entity.

methodstatic

#public static void SetDebugDraw(Entity e, bool value)

Sets the Buoyancy component's Debug Draw value on the entity.

methodstatic

#public static bool IsSubmerged(Entity e)

Reads the Buoyancy component's Submerged value of the entity.

methodstatic

#public static bool IsWakeGenerationEnabled(Entity e)

Reads the Buoyancy component's Wake Generation Enabled value of the entity.

methodstatic

#public static void SetWakeGeneration(Entity e, bool value)

Sets the Buoyancy component's Wake Generation value on the entity.

methodstatic

#public static bool CanFlip(Entity e)

Reads the Buoyancy component's can flip flag of the entity.

methodstatic

#public static void SetCanFlip(Entity e, bool value)

Sets the Buoyancy component's Can Flip value on the entity.

methodstatic

#public static bool SimulatesInEditor(Entity e)

Reads the Buoyancy component's simulates in editor flag of the entity.

methodstatic

#public static void SetSimulateInEditor(Entity e, bool value)

Sets the Buoyancy component's Simulate In Editor value on the entity.

methodstatic

#public static uint GetSamplePointCount(Entity e)

Reads the Buoyancy component's Sample Point Count value of the entity.

methodstatic

#public static void SetSamplePointCount(Entity e, uint value)

Sets the Buoyancy component's Sample Point Count value on the entity.

methodstatic

#public static uint GetMaximumWakePoints(Entity e)

Reads the Buoyancy component's Maximum Wake Points value of the entity.

methodstatic

#public static void SetMaximumWakePoints(Entity e, uint value)

Sets the Buoyancy component's Maximum Wake Points value on the entity.

methodstatic

#public static float GetFluidDensity(Entity e)

Reads the Buoyancy component's Fluid Density value of the entity.

methodstatic

#public static void SetFluidDensity(Entity e, float value)

Sets the Buoyancy component's Fluid Density value on the entity.

methodstatic

#public static float GetBuoyancyScale(Entity e)

Reads the Buoyancy component's Buoyancy Scale value of the entity.

methodstatic

#public static void SetBuoyancyScale(Entity e, float value)

Sets the Buoyancy component's Buoyancy Scale value on the entity.

methodstatic

#public static float GetMaxSubmersionDepth(Entity e)

Reads the Buoyancy component's Max Submersion Depth value of the entity.

methodstatic

#public static void SetMaxSubmersionDepth(Entity e, float value)

Sets the Buoyancy component's Max Submersion Depth value on the entity.

methodstatic

#public static float GetLinearDrag(Entity e)

Reads the Buoyancy component's Linear Drag value of the entity.

methodstatic

#public static void SetLinearDrag(Entity e, float value)

Sets the Buoyancy component's Linear Drag value on the entity.

methodstatic

#public static float GetAngularDrag(Entity e)

Reads the Buoyancy component's Angular Drag value of the entity.

methodstatic

#public static void SetAngularDrag(Entity e, float value)

Sets the Buoyancy component's Angular Drag value on the entity.

methodstatic

#public static float GetSurfaceAlignment(Entity e)

Reads the Buoyancy component's Surface Alignment value of the entity.

methodstatic

#public static void SetSurfaceAlignment(Entity e, float value)

Sets the Buoyancy component's Surface Alignment value on the entity.

methodstatic

#public static float GetSubmergedFraction(Entity e)

Reads the Buoyancy component's Submerged Fraction value of the entity.

methodstatic

#public static float GetWakeStrength(Entity e)

Reads the Buoyancy component's Wake Strength value of the entity.

methodstatic

#public static void SetWakeStrength(Entity e, float value)

Sets the Buoyancy component's Wake Strength value on the entity.

methodstatic

#public static float GetWakeWidth(Entity e)

Reads the Buoyancy component's Wake Width value of the entity.

methodstatic

#public static void SetWakeWidth(Entity e, float value)

Sets the Buoyancy component's Wake Width value on the entity.

methodstatic

#public static float GetWakeLifetime(Entity e)

Reads the Buoyancy component's Wake Lifetime value of the entity.

methodstatic

#public static void SetWakeLifetime(Entity e, float value)

Sets the Buoyancy component's Wake Lifetime value on the entity.

methodstatic

#public static float GetWakeSpacing(Entity e)

Reads the Buoyancy component's Wake Spacing value of the entity.

methodstatic

#public static void SetWakeSpacing(Entity e, float value)

Sets the Buoyancy component's Wake Spacing value on the entity.

methodstatic

#public static float GetWakeMinimumSpeed(Entity e)

Reads the Buoyancy component's Wake Minimum Speed value of the entity.

methodstatic

#public static void SetWakeMinimumSpeed(Entity e, float value)

Sets the Buoyancy component's Wake Minimum Speed value on the entity.

methodstatic

#public static float GetTargetSubmersion(Entity e)

Reads the Buoyancy component's Target Submersion value of the entity.

methodstatic

#public static void SetTargetSubmersion(Entity e, float value)

Sets the Buoyancy component's Target Submersion value on the entity.

methodstatic

#public static float GetHullVolumeScale(Entity e)

Reads the Buoyancy component's Hull Volume Scale value of the entity.

methodstatic

#public static void SetHullVolumeScale(Entity e, float value)

Sets the Buoyancy component's Hull Volume Scale value on the entity.

methodstatic

#public static float GetEstimatedDisplacementVolume(Entity e)

Reads the Buoyancy component's Estimated Displacement Volume value of the entity.

methodstatic

#public static float GetMaximumSupportedMass(Entity e)

Reads the Buoyancy component's Maximum Supported Mass value of the entity.

methodstatic

#public static float GetUprightStiffness(Entity e)

Reads the Buoyancy component's Upright Stiffness value of the entity.

methodstatic

#public static void SetUprightStiffness(Entity e, float value)

Sets the Buoyancy component's Upright Stiffness value on the entity.

methodstatic

#public static float GetUprightDamping(Entity e)

Reads the Buoyancy component's Upright Damping value of the entity.

methodstatic

#public static void SetUprightDamping(Entity e, float value)

Sets the Buoyancy component's Upright Damping value on the entity.

methodstatic

#public static Vector3 GetLocalCenter(Entity e)

Reads the Buoyancy component's Local Center value of the entity.

methodstatic

#public static void SetLocalCenter(Entity e, Vector3 value)

Sets the Buoyancy component's Local Center value on the entity.

methodstatic

#public static Vector3 GetLocalHalfExtents(Entity e)

Reads the Buoyancy component's Local Half Extents value of the entity.

methodstatic

#public static void SetLocalHalfExtents(Entity e, Vector3 value)

Sets the Buoyancy component's Local Half Extents value on the entity.

methodstatic

#public static Entity GetWaterBody(Entity e)

The water body entity the buoyancy samples (invalid for the scene's ocean).

methodstatic

#public static void SetWaterBody(Entity e, Entity waterBody)

Sets the water body entity the buoyancy samples.

methodstatic

#public static BuoyancyForceModel GetForceModel(Entity e)

How the Buoyancy computes its forces.

methodstatic

#public static void SetForceModel(Entity e, BuoyancyForceModel value)

Sets how the Buoyancy computes its forces.

methodstatic

#public static BuoyancySamplingMode GetSamplingMode(Entity e)

Where the Buoyancy samples the water height.

methodstatic

#public static void SetSamplingMode(Entity e, BuoyancySamplingMode value)

Sets where the Buoyancy samples the water height.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static bool IsAutoFitColliderEnabled(Entity e)
public static void SetAutoFitCollider(Entity e, bool value)
public static bool IsDebugDrawEnabled(Entity e)
public static void SetDebugDraw(Entity e, bool value)
public static bool IsSubmerged(Entity e)
public static bool IsWakeGenerationEnabled(Entity e)
public static void SetWakeGeneration(Entity e, bool value)
public static bool CanFlip(Entity e)
public static void SetCanFlip(Entity e, bool value)
public static bool SimulatesInEditor(Entity e)
public static void SetSimulateInEditor(Entity e, bool value)
public static uint GetSamplePointCount(Entity e)
public static void SetSamplePointCount(Entity e, uint value)
public static uint GetMaximumWakePoints(Entity e)
public static void SetMaximumWakePoints(Entity e, uint value)
public static float GetFluidDensity(Entity e)
public static void SetFluidDensity(Entity e, float value)
public static float GetBuoyancyScale(Entity e)
public static void SetBuoyancyScale(Entity e, float value)
public static float GetMaxSubmersionDepth(Entity e)
public static void SetMaxSubmersionDepth(Entity e, float value)
public static float GetLinearDrag(Entity e)
public static void SetLinearDrag(Entity e, float value)
public static float GetAngularDrag(Entity e)
public static void SetAngularDrag(Entity e, float value)
public static float GetSurfaceAlignment(Entity e)
public static void SetSurfaceAlignment(Entity e, float value)
public static float GetSubmergedFraction(Entity e)
public static float GetWakeStrength(Entity e)
public static void SetWakeStrength(Entity e, float value)
public static float GetWakeWidth(Entity e)
public static void SetWakeWidth(Entity e, float value)
public static float GetWakeLifetime(Entity e)
public static void SetWakeLifetime(Entity e, float value)
public static float GetWakeSpacing(Entity e)
public static void SetWakeSpacing(Entity e, float value)
public static float GetWakeMinimumSpeed(Entity e)
public static void SetWakeMinimumSpeed(Entity e, float value)
public static float GetTargetSubmersion(Entity e)
public static void SetTargetSubmersion(Entity e, float value)
public static float GetHullVolumeScale(Entity e)
public static void SetHullVolumeScale(Entity e, float value)
public static float GetEstimatedDisplacementVolume(Entity e)
public static float GetMaximumSupportedMass(Entity e)
public static float GetUprightStiffness(Entity e)
public static void SetUprightStiffness(Entity e, float value)
public static float GetUprightDamping(Entity e)
public static void SetUprightDamping(Entity e, float value)
public static Vector3 GetLocalCenter(Entity e)
public static void SetLocalCenter(Entity e, Vector3 value)
public static Vector3 GetLocalHalfExtents(Entity e)
public static void SetLocalHalfExtents(Entity e, Vector3 value)
public static Entity GetWaterBody(Entity e)
public static void SetWaterBody(Entity e, Entity waterBody)
public static BuoyancyForceModel GetForceModel(Entity e)
public static void SetForceModel(Entity e, BuoyancyForceModel value)
public static BuoyancySamplingMode GetSamplingMode(Entity e)
public static void SetSamplingMode(Entity e, BuoyancySamplingMode value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.