SCRIPTING API / Rendering and effects / Terrain

Terrain

Script access to an entity's Terrain: size, height scale, resolution, material and brush settings.

Kindclass

NamespaceKroys.EngineScripting

Members23

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class Terrain

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Terrain component.

methodstatic

#public static float GetWidth(Entity e)

Reads the Terrain component's Width value of the entity.

methodstatic

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

Sets the Terrain component's Width value on the entity.

methodstatic

#public static float GetLength(Entity e)

Reads the Terrain component's Length value of the entity.

methodstatic

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

Sets the Terrain component's Length value on the entity.

methodstatic

#public static float GetHeightScale(Entity e)

Reads the Terrain component's Height Scale value of the entity.

methodstatic

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

Sets the Terrain component's Height Scale value on the entity.

methodstatic

#public static uint GetResolutionX(Entity e)

Reads the Terrain component's Resolution X value of the entity.

methodstatic

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

Sets the Terrain component's Resolution X value on the entity.

methodstatic

#public static uint GetResolutionZ(Entity e)

Reads the Terrain component's Resolution Z value of the entity.

methodstatic

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

Sets the Terrain component's Resolution Z value on the entity.

methodstatic

#public static TerrainBrushMode GetBrushMode(Entity e)

Reads the Terrain component's Brush Mode value of the entity.

methodstatic

#public static void SetBrushMode(Entity e, TerrainBrushMode value)

Sets the Terrain component's Brush Mode value on the entity.

methodstatic

#public static GameplayLayer GetSurfaceLayer(Entity e)

Reads the Terrain component's Surface Layer value of the entity.

methodstatic

#public static void SetSurfaceLayer(Entity e, GameplayLayer value)

Sets the Terrain component's Surface Layer value on the entity.

methodstatic

#public static float GetBrushRadius(Entity e)

Reads the Terrain component's Brush Radius value of the entity.

methodstatic

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

Sets the Terrain component's Brush Radius value on the entity.

methodstatic

#public static float GetBrushStrength(Entity e)

Reads the Terrain component's Brush Strength value of the entity.

methodstatic

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

Sets the Terrain component's Brush Strength value on the entity.

methodstatic

#public static ulong GetMaterial(Entity e)

Reads the Terrain component's Material value of the entity.

methodstatic

#public static void SetMaterial(Entity e, ulong value)

Sets the Terrain component's Material value on the entity.

methodstatic

#public static float GetFlattenHeight(Entity e)

Reads the Terrain component's Flatten Height value of the entity.

methodstatic

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

Sets the Terrain component's Flatten Height value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static float GetWidth(Entity e)
public static void SetWidth(Entity e, float value)
public static float GetLength(Entity e)
public static void SetLength(Entity e, float value)
public static float GetHeightScale(Entity e)
public static void SetHeightScale(Entity e, float value)
public static uint GetResolutionX(Entity e)
public static void SetResolutionX(Entity e, uint value)
public static uint GetResolutionZ(Entity e)
public static void SetResolutionZ(Entity e, uint value)
public static TerrainBrushMode GetBrushMode(Entity e)
public static void SetBrushMode(Entity e, TerrainBrushMode value)
public static GameplayLayer GetSurfaceLayer(Entity e)
public static void SetSurfaceLayer(Entity e, GameplayLayer value)
public static float GetBrushRadius(Entity e)
public static void SetBrushRadius(Entity e, float value)
public static float GetBrushStrength(Entity e)
public static void SetBrushStrength(Entity e, float value)
public static ulong GetMaterial(Entity e)
public static void SetMaterial(Entity e, ulong value)
public static float GetFlattenHeight(Entity e)
public static void SetFlattenHeight(Entity e, float value)

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