Class SceneBiomeMap

Namespace

FishMMO.Shared.Biomes

Assembly

FishMMO.Shared.dll

Which biome lies where in a scene, baked when the world was generated: a grid of BiomeTemplate IDs over a rectangle of world space. Imported from the biome-map cells WorldEditor exports, or painted by any other tool; both the server and the client read it, so it holds IDs rather than a texture.

[CreateAssetMenu(fileName = "New Scene Biome Map", menuName = "FishMMO/Biomes/Scene Biome Map", order = 3)]
public class SceneBiomeMap : CachedScriptableObject<SceneBiomeMap>, ICachedObject

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<SceneBiomeMap>

SceneBiomeMap

Implements

ICachedObject

Inherited Members

CachedScriptableObject<SceneBiomeMap>.ID

CachedScriptableObject<SceneBiomeMap>.AddToCache(string)

CachedScriptableObject<SceneBiomeMap>.RemoveFromCache()

CachedScriptableObject<SceneBiomeMap>.OnLoad(string, string, int)

CachedScriptableObject<SceneBiomeMap>.OnUnload(string, string, int)

CachedScriptableObject<SceneBiomeMap>.Get<U>(int)

CachedScriptableObject<SceneBiomeMap>.GetFirst<U>()

CachedScriptableObject<SceneBiomeMap>.GetCache<U>()

CachedScriptableObject<SceneBiomeMap>.Get<U>(HashSet<int>)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

BiomeIDs

[Tooltip("BiomeTemplate cached-object IDs, row-major from the south-west corner; 0 = no biome.")]
[HideInInspector]
public int[] BiomeIDs

Field Value

int[]

Height

[Tooltip("Grid rows (world Z).")]
[Min(1)]
public int Height

Field Value

int

Width

[Tooltip("Grid columns (world X).")]
[Min(1)]
public int Width

Field Value

int

WorldOrigin

[Tooltip("World-space X/Z of the grid's south-west corner.")]
public Vector2 WorldOrigin

Field Value

Vector2

WorldSize

[Tooltip("World-space extent of the grid along X and Z.")]
public Vector2 WorldSize

Field Value

Vector2

Methods

Contains(Vector3)

True when the position's X/Z lies inside the grid's rectangle.

public bool Contains(Vector3 worldPosition)

Parameters

worldPosition Vector3

Returns

bool

IDAt(Vector3)

The biome ID under a world position, or 0 outside the grid or where none was baked.

public int IDAt(Vector3 worldPosition)

Parameters

worldPosition Vector3

Returns

int

Latitude01(Vector3)

0 at the south edge, 1 at the north edge; the equator is 0.5.

public float Latitude01(Vector3 worldPosition)

Parameters

worldPosition Vector3

Returns

float

Sample(Vector3)

The biome under a world position, or null.

public BiomeTemplate Sample(Vector3 worldPosition)

Parameters

worldPosition Vector3

Returns

BiomeTemplate

Set(int, int, int[], Vector2, Vector2)

Replaces the whole grid.

public void Set(int width, int height, int[] biomeIDs, Vector2 worldOrigin, Vector2 worldSize)

Parameters

width int

height int

biomeIDs int[]

worldOrigin Vector2

worldSize Vector2