clip #
public string clip { get; set; }
.kanim path).
Kaskade
Scripting guide
Reference for Kaskade.Managed.API. Open a type for its signatures, lifecycle callbacks, and overloads. For setup and working examples, start with the scripting guide.
No matching types or members.
Kaskade
public sealed class Animator
Inherits EngineComponent
public string clip { get; set; }
.kanim path).public string currentState { get; }
public bool isInTransition { get; }
public double speed { get; set; }
public void CrossFade(string state, float duration)
duration seconds.public float GetFloat(string name)
public void Play(string? clip = null)
clip (or the current clip) from the start.public void PlayState(string state, int layer = 0)
public void ResetTrigger(string name)
public void SetBool(string name, bool value)
public void SetFloat(string name, float value)
public void SetInteger(string name, int value)
public void SetTrigger(string name)
public void Stop()
Kaskade
public static class Application
Application).public static string dataPath { get; }
Assets folder (Unity's dataPath).public static bool isFocused { get; }
public static bool isPlaying { get; }
public static string projectPath { get; }
public static void Quit()
Kaskade
public sealed class AssetAttribute
Inherits Attribute
public AssetAttribute(string kind = "")
public string Kind { get; }
Kaskade
public sealed class AudioClip
Implements IEquatable<AudioClip>
.wav, .ogg, .mp3, .flac): what
AudioSource plays. A script field of this type is an audio slot in the inspector
(pick a clip, listen to it); AudioClip.Load names one in code.
public string name { get; }
public string path { get; }
Assets/Audio/Doors/open.wav), or relative to Assets/Audio without the
extension (Doors/open).public bool Equals(AudioClip? other)
bool IEquatable<AudioClip>.Equals(AudioClip? other).public override bool Equals(object? obj)
bool object.Equals(object? obj).public override int GetHashCode()
int object.GetHashCode().public static AudioClip? Load(string? path)
path (see AudioClip.path), or null for an
empty path or "None".public override string ToString()
string? object.ToString().public static implicit operator string(AudioClip? clip)
public static implicit operator AudioClip?(string? path)
AudioClip field, or AudioClip.Load.
Kaskade
public sealed class AudioListener
Inherits EngineComponent
public double volume { get; set; }
Kaskade
public sealed class AudioSource
Inherits EngineComponent
public AudioClip? clip { get; set; }
public bool isPlaying { get; }
public bool loop { get; set; }
public double maxDistance { get; set; }
public double minDistance { get; set; }
public double pitch { get; set; }
public bool playOnAwake { get; set; }
public double spatialBlend { get; set; }
public double volume { get; set; }
public void Play()
public static void PlayClipAtPoint(AudioClip? clip, Vector3 position, double volume = 1)
clip once at a world position (nothing for null).public static void PlayClipAtPoint(string clip, Vector3 position, double volume = 1)
public void PlayOneShot(AudioClip? clip, double volumeScale = 1)
clip once at the object's position, over whatever plays.public void PlayOneShot(string clip, double volumeScale = 1)
public static long PlayVoice(AudioClip? clip, double volume = 1)
clip once as recorded, heard everywhere (a narrator, a PA); it
pauses with the game. Returns the voice, for AudioSource.StopVoice (0 for null).
public static long PlayVoice(string clip, double volume = 1)
public void Stop()
public static void StopVoice(long voice)
AudioSource.PlayVoice (one that ended already: nothing).Kaskade
public abstract class Behaviour
Inherits Component
Behaviour.Awake, Behaviour.OnEnable,
Behaviour.Start (before the first update), then every frame Behaviour.FixedUpdate (per
physics step), Behaviour.Update, Behaviour.LateUpdate, Behaviour.OnGUI; physics
reports OnCollisionEnter/Stay/Exit and OnTriggerEnter/Stay/Exit; at the end
Behaviour.OnDisable and Behaviour.OnDestroy.
protected Behaviour()
public bool enabled { get; set; }
public bool isActiveAndEnabled { get; }
protected virtual void Awake()
Behaviour.Start.public void CancelInvoke(string? methodName = null)
Behaviour.Invoke calls (of one method, or all).protected virtual void FixedUpdate()
Time.fixedDeltaTime apart); move rigidbodies here.public void Invoke(string methodName, double time)
methodName after time seconds.public void InvokeRepeating(string methodName, double time, double repeatRate)
time seconds, then every repeatRate seconds.public bool IsInvoking(string? methodName = null)
methodName (or any) is pending.protected virtual void LateUpdate()
protected virtual void LateUpdate(double deltaTime)
protected virtual void OnAfterHotReload(HotReloadContext context)
protected virtual void OnBeforeHotReload()
protected virtual void OnCollisionEnter(Collision collision)
protected virtual void OnCollisionExit(Collision collision)
protected virtual void OnCollisionStay(Collision collision)
protected virtual void OnDestroy()
protected virtual void OnDisable()
protected virtual void OnEnable()
protected virtual void OnGUI()
protected virtual void OnReady()
Behaviour.Awake: called once after the component and its object are ready.protected virtual void OnReset()
protected virtual void OnTriggerEnter(Collider other)
protected virtual void OnTriggerExit(Collider other)
protected virtual void OnTriggerStay(Collider other)
protected virtual void Start()
public Coroutine StartCoroutine(IEnumerator routine)
routine as a coroutine: it continues after each yield return
(null: next frame; WaitForSeconds; WaitUntil;
WaitForFixedUpdate; WaitForEndOfFrame; another coroutine or
enumerator: when it finishes).
public Coroutine StartCoroutine(string methodName, object? value = null)
methodName.public void StopAllCoroutines()
public void StopCoroutine(Coroutine coroutine)
public void StopCoroutine(IEnumerator routine)
routine.protected virtual void Update()
protected virtual void Update(double deltaTime)
Time.deltaTime).public static void print(object? message)
message to the console (Unity's print).Kaskade
public readonly readonly struct BonePose
Implements IEquatable<BonePose>
public BonePose()
public BonePose(Vector3 localPosition, Quaternion localRotation, Vector3 position, Quaternion rotation)
public Vector3 localPosition { get; init; }
public Quaternion localRotation { get; init; }
public Vector3 position { get; init; }
public Quaternion rotation { get; init; }
public void Deconstruct(out Vector3 localPosition, out Quaternion localRotation, out Vector3 position, out Quaternion rotation)
public bool Equals(BonePose other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(BonePose left, BonePose right)
public static bool operator !=(BonePose left, BonePose right)
Kaskade
public struct Bounds
public Bounds()
public Bounds(Vector3 center, Vector3 size)
public Vector3 center
public Vector3 extents
public readonly Vector3 max { get; }
public readonly Vector3 min { get; }
public Vector3 size { readonly get; set; }
public readonly Vector3 ClosestPoint(Vector3 point)
public readonly bool Contains(Vector3 point)
point is inside.public void Encapsulate(Bounds other)
other.public void Encapsulate(Vector3 point)
point.public readonly bool IntersectRay(Ray ray)
ray hits the box (Unity's Bounds.IntersectRay).public readonly bool IntersectRay(Ray ray, out double distance)
ray hits the box, and how far along it the ray enters
(Unity's Bounds.IntersectRay). A ray starting inside hits with a negative
distance (back to where it would have entered); a box wholly behind the
ray is missed.
Kaskade
public sealed class BoxCollider
Inherits Collider
public Vector3 center { get; set; }
public Vector3 size { get; set; }
Kaskade
public sealed class Camera
Inherits EngineComponent
Camera.main is the scene's main camera; its screen and world conversions use its
position, rotation and field of view. Screen points are window pixels from the top-left corner,
as Input.mousePosition gives them.
public static Camera[] allCameras { get; }
public double aspect { get; }
public Color backgroundColor { get; set; }
public int depth { get; set; }
public double farClipPlane { get; set; }
public double fieldOfView { get; set; }
public bool isMainCamera { get; set; }
public static Camera? main { get; }
public double nearClipPlane { get; set; }
public int pixelHeight { get; }
public int pixelWidth { get; }
public Ray ScreenPointToRay(Vector2 screenPoint)
public bool ScreenPointToWorldPos(Vector2 screenPoint, out RaycastHit hit, double maxDistance = 1000)
public Vector3? ScreenPointToWorldPos(Vector2 screenPoint, double maxDistance = 1000)
maxDistance metres; null when nothing is there.
public Vector3 ScreenToWorldPoint(Vector2 screenPoint, double distance)
distance metres along the ray through a screen point (no physics).public Vector3 ScreenToWorldPoint(Vector3 screenPoint)
public Ray ViewportPointToRay(Vector2 viewportPoint)
public Vector3 WorldToScreenPoint(Vector3 worldPoint)
public bool WorldToScreenPoint(Vector3 worldPoint, out Vector2 screenPoint)
public Vector3 WorldToViewportPoint(Vector3 worldPoint)
Kaskade
public sealed class CapsuleCollider
Inherits Collider
public double height { get; set; }
public double radius { get; set; }
Kaskade
public sealed class CharacterController
Inherits Collider
public Vector3 groundNormal { get; }
public double height { get; set; }
public bool isGrounded { get; }
public double radius { get; set; }
public double slopeLimit { get; set; }
public double stepOffset { get; set; }
public void Move(Vector3 motion)
motion (world space, metres), sliding along what it hits.public void SimpleMove(Vector3 speed)
speed (metres per second) for this frame, with gravity.Kaskade
public abstract class Collider
Inherits EngineComponent
public Rigidbody? attachedRigidbody { get; }
public bool isTrigger { get; set; }
OnTriggerEnter/OnTriggerExit report them.
public Vector3 ClosestPoint(Vector3 position)
position.public bool Raycast(Ray ray, out RaycastHit hit, double maxDistance)
Kaskade
public sealed class Collision
OnCollisionEnter/Stay/Exit.public Collider? collider { get; }
public int contactCount { get; }
public ContactPoint[] contacts { get; }
public GameObject gameObject { get; }
public Vector3 relativeVelocity { get; }
public Rigidbody? rigidbody { get; }
public Transform transform { get; }
public ContactPoint GetContact(int index)
index.Kaskade
public struct Color
public Color()
public Color(double r, double g, double b, double a = 1)
public Color(float r, float g, float b, float a = 1)
public float a
public float b
public float g
public float r
public float A { get; set; }
public float B { get; set; }
public static Color Black { get; }
public static Color Blue { get; }
public static Color Clear { get; }
public static Color Cyan { get; }
public float G { get; set; }
public static Color Gray { get; }
public static Color Green { get; }
public static Color Magenta { get; }
public float R { get; set; }
public static Color Red { get; }
public static Color White { get; }
public static Color Yellow { get; }
public static Color black { get; }
public static Color blue { get; }
public static Color clear { get; }
public static Color cyan { get; }
public static Color gray { get; }
public static Color green { get; }
public static Color grey { get; }
public static Color magenta { get; }
public static Color red { get; }
public static Color white { get; }
public static Color yellow { get; }
public override bool Equals(object? obj)
bool ValueType.Equals(object? obj).public override int GetHashCode()
int ValueType.GetHashCode().public static Color Lerp(Color a, Color b, double t)
a and b (t clamped to 0..1).public static Color LerpUnclamped(Color a, Color b, double t)
a and b.public override string ToString()
string? ValueType.ToString().public static Color operator +(Color a, Color b)
public static bool operator ==(Color lhs, Color rhs)
public static bool operator !=(Color lhs, Color rhs)
public static Color operator *(Color a, Color b)
public static Color operator *(Color a, double b)
public static Color operator *(Color a, float b)
public static Color operator -(Color a, Color b)
Kaskade
public abstract class Component
Inherits Object
Component.GameObject: a C# Behaviour, the
Component.Transform, or an engine component (Rigidbody, Light, ...).
public GameObject GameObject { get; }
Component.gameObject.public Transform Transform { get; }
Component.transform.public GameObject gameObject { get; }
public override string name { get; set; }
public string tag { get; set; }
public Transform transform { get; }
public void BroadcastMessage(string methodName, object? value = null)
public bool CompareTag(string tag)
tag.public Component? GetComponent(Type type)
type, or null.public T? GetComponent<T>()
T, or null.public T? GetComponentInChildren<T>(bool includeInactive = false)
T on the game object or its descendants.public T? GetComponentInParent<T>()
T on the game object or its ancestors.public T[] GetComponents<T>()
T.public T[] GetComponentsInChildren<T>(bool includeInactive = false)
T on the game object and its descendants.public T[] GetComponentsInParent<T>()
T on the game object and its ancestors.public override int GetInstanceID()
public void SendMessage(string methodName, object? value = null)
methodName on every C# behaviour of the game object.public bool TryGetComponent<T>(out T component)
T.Kaskade
public readonly readonly struct ComponentHandle
public ComponentHandle()
public bool IsValid { get; }
Kaskade
public sealed class ComputeBuffer
Implements IDisposable
ComputeBuffer): count elements of
stride bytes, a StructuredBuffer / RWStructuredBuffer to shaders.
public ComputeBuffer(int count, int stride)
count elements of stride bytes.public int count { get; }
public int stride { get; }
public void Dispose()
public bool GetData<T>(T[] data) where T : unmanaged
data: what was read back on an earlier frame (the
first call asks and returns false; GPU work is carried out between frames).
public bool IsValid()
public void Release()
public void SetData<T>(List<T> data) where T : unmanaged
public void SetData<T>(T[] data) where T : unmanaged
data (any unmanaged element type).Kaskade
public sealed class ComputeShader
ComputeShader): a .compute (kernels named by
#pragma kernel), an .hlsl or a compiled .fxc. Values set here bind to
the kernels by name at ComputeShader.Dispatch.
public string path { get; }
public void Dispatch(int kernel, int x, int y, int z)
x*y*z thread groups.public int FindKernel(string name)
public void GetKernelThreadGroupSizes(int kernel, out uint x, out uint y, out uint z)
public bool HasKernel(string name)
public static ComputeShader Load(string path)
path (project-relative).public void SetBool(string name, bool value)
public void SetBuffer(int kernel, string name, ComputeBuffer buffer)
public void SetFloat(string name, float value)
public void SetFloats(string name, params float[] values)
public void SetInt(string name, int value)
public void SetInts(string name, params int[] values)
public void SetMatrix(string name, Matrix4x4 value)
public void SetTexture(int kernel, string name, Texture texture)
public void SetVector(string name, Vector4 value)
public void SetVectorArray(string name, Vector4[] values)
Kaskade
public sealed class ConVar
name value.public bool Bool { get; }
public float Float { get; }
public int Int { get; }
public string Name { get; }
public string String { get; set; }
Kaskade
public enum ConVarFlags
Cheat = 1
sv_cheats is 1.Hidden = 2
find.None = 0
Kaskade
public readonly readonly struct ContactPoint
Implements IEquatable<ContactPoint>
public ContactPoint()
public ContactPoint(Vector3 point, Vector3 normal)
public Vector3 normal { get; init; }
public Vector3 point { get; init; }
public void Deconstruct(out Vector3 point, out Vector3 normal)
public bool Equals(ContactPoint other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(ContactPoint left, ContactPoint right)
public static bool operator !=(ContactPoint left, ContactPoint right)
Kaskade
public sealed class Coroutine
Inherits YieldInstruction
Behaviour.StartCoroutine); yield it to wait for it to finish.public bool IsDone { get; }
Kaskade
public static class Cursor
public static CursorLockMode lockState { get; set; }
public static bool visible { get; set; }
Kaskade
public enum CursorLockMode
Confined = 2
CursorLockMode.Locked).Locked = 1
None = 0
Kaskade
public abstract class CustomYieldInstruction
Implements IEnumerator
CustomYieldInstruction.keepWaiting is true (checked every frame).protected CustomYieldInstruction()
public abstract bool keepWaiting { get; }
Kaskade
public static class Debug
public static void Assert(bool condition, object? message = null)
condition is false.public static void DrawLine(Vector3 start, Vector3 end, Color? color = null, double duration = 0)
duration seconds (0: one frame).public static void DrawRay(Vector3 start, Vector3 direction, Color? color = null, double duration = 0)
start along direction.public static void Log(object? message)
public static void Log(object? message, Object? context)
context.public static void LogError(object? message)
public static void LogError(object? message, Object? context)
context.public static void LogException(Exception exception)
public static void LogFormat(string format, params object?[] args)
System.String.Format(System.String,System.Object[]).public static void LogWarning(object? message)
public static void LogWarning(object? message, Object? context)
context.Kaskade
public static class DevConsole
public static void Execute(string line)
;).public static string? GetVar(string name)
public static void Print(string text)
public static void Print(string text, Color color)
color.public static void RegisterCommand(string name, Action<string[]> callback, string help = "", ConVarFlags flags = ConVarFlags.None)
callback gets its arguments.public static ConVar RegisterVar(string name, string defaultValue, string help = "", ConVarFlags flags = ConVarFlags.None)
public static bool SetVar(string name, string value)
Kaskade
public abstract class EngineComponent
Inherits Component
public bool enabled { get; set; }
Kaskade
public enum FindObjectsInactive
Exclude = 0
Include = 1
Kaskade
public enum FindObjectsSortMode
InstanceID = 1
None = 0
Kaskade
public sealed class Font
public Font(string path)
public string path
public static implicit operator Font(string path)
Kaskade
public enum FontStyle
Bold = 1
BoldAndItalic = 3
Italic = 2
Normal = 0
Kaskade
public enum ForceMode
Acceleration = 3
Force = 0
Impulse = 1
VelocityChange = 2
Kaskade
public sealed class FormerlySerializedAsAttribute
Inherits Attribute
public FormerlySerializedAsAttribute(string name)
public string Name { get; }
Kaskade
public static class GUI
public static Color backgroundColor { get; set; }
public static Color color { get; set; }
public static Color contentColor { get; set; }
public static bool enabled { get; set; }
public static Matrix4x4 matrix { get; set; }
public static GUISkin skin { get; set; }
public static void Box(Rect position, string text)
public static void Box(Rect position, string text, GUIStyle style)
style's color.public static bool Button(Rect position, string text)
public static bool Button(Rect position, string text, GUIStyle style)
style's color.public static void DrawTexture(Rect position, Texture? image)
public static void DrawTexture(Rect position, Texture? image, ScaleMode scaleMode, bool alphaBlend = true)
GUI.DrawTexture).public static float HorizontalScrollbar(Rect position, float value, float size, float leftValue, float rightValue)
public static float HorizontalSlider(Rect position, float value, float leftValue, float rightValue)
public static void Label(Rect position, string text)
public static void Label(Rect position, string text, GUIStyle style)
style's color.public static string PasswordField(Rect position, string password, char mask = '*', int maxLength = 256)
public static bool RepeatButton(Rect position, string text)
public static string TextArea(Rect position, string text, int maxLength = 1024)
public static string TextField(Rect position, string text, int maxLength = 256)
public static bool Toggle(Rect position, bool value, string text)
public static float VerticalScrollbar(Rect position, float value, float size, float topValue, float bottomValue)
public static float VerticalSlider(Rect position, float value, float topValue, float bottomValue)
Kaskade
public static class GUILayout
public static void BeginArea(Rect screenRect)
public static void BeginHorizontal()
public static Vector2 BeginScrollView(Vector2 scrollPosition, float width = 0, float height = 0)
public static void BeginVertical()
public static void Box(string text)
public static bool Button(string text)
public static void EndArea()
public static void EndHorizontal()
public static void EndScrollView()
public static void EndVertical()
public static void FlexibleSpace()
public static float HorizontalSlider(float value, float leftValue, float rightValue)
public static void Label(string text)
public static string PasswordField(string password, char mask = '*', int maxLength = 256)
public static bool RepeatButton(string text)
public static void Space(float pixels)
public static string TextArea(string text, int maxLength = 1024)
public static string TextField(string text, int maxLength = 256)
public static bool Toggle(bool value, string text)
public static float VerticalSlider(float value, float topValue, float bottomValue)
Kaskade
public sealed class GUISkin
public GUISkin()
public GUIStyle box
public GUIStyle button
public Font? font
public GUIStyle label
public GUIStyle textField
Kaskade
public sealed class GUIStyle
public GUIStyle()
public GUIStyle(GUIStyle other)
other.public TextAnchor alignment
public Font? font
public int fontSize
public FontStyle fontStyle
public GUIStyleState hover
public GUIStyleState normal
public bool richText
public bool wordWrap
Kaskade
public sealed class GUIStyleState
public GUIStyleState()
public Texture2D? background
public Color textColor
Kaskade
public sealed class GameObject
Inherits Object
GameObject.transform and components. Also a prefab asset
to make objects from: a [SerializeField] GameObject field takes an object from the
Hierarchy or a .kprefab from the Project panel, either works with
Object.Instantiate.
public GameObject()
public GameObject(string name)
public GameObject(string name, params Type[] components)
public bool IsAlive { get; }
this existing (if (gameObject)).public bool IsPrefab { get; }
public string? PrefabPath { get; }
public Rigidbody Rigidbody { get; }
Rigidbody: use GetComponent<Rigidbody>().public Transform Transform { get; }
GameObject.transform.public bool activeInHierarchy { get; }
public bool activeSelf { get; }
public int layer { get; set; }
public override string name { get; set; }
public Scene scene { get; }
public string tag { get; set; }
public Transform transform { get; }
public Component AddComponent(Type type)
type (see GameObject.AddComponent).public T AddComponent<T>() where T : Component
GameObject.Rigidbody,
BoxCollider, Light, AudioSource, ...). It is returned at
once; its callbacks start with the next frame.
public void BroadcastMessage(string methodName, object? value = null)
methodName on the object's behaviours and its descendants'.public bool CompareTag(string tag)
tag.public static GameObject? Find(string name)
name (or at path "Parent/Child"), or null.public static GameObject? FindGameObjectWithTag(string tag)
GameObject.FindWithTag.public static GameObject[] FindGameObjectsWithTag(string tag)
tag.public static GameObject? FindWithTag(string tag)
tag, or null.public Component? GetComponent(Type type)
type, or null.public T? GetComponent<T>()
T, or null: a C# behaviour, an engine
component (GameObject.Rigidbody, Light, ...), GameObject.Transform or a
generated Zito proxy.
public T? GetComponentInChildren<T>(bool includeInactive = false)
T on the object or its descendants.public T? GetComponentInParent<T>()
T on the object or its ancestors.public T[] GetComponents<T>()
T.public T[] GetComponentsInChildren<T>(bool includeInactive = false)
T on the object and its descendants.public T[] GetComponentsInParent<T>()
T on the object and its ancestors.public override int GetInstanceID()
public Rigidbody GetRigidbody()
Rigidbody: use GetComponent<Rigidbody>().public static GameObject Prefab(string path)
path (a project-relative .kprefab).public void SendMessage(string methodName, object? value = null)
methodName on every C# behaviour of the object.public void SendMessageUpwards(string methodName, object? value = null)
methodName on the object's behaviours and its ancestors'.public void SetActive(bool value)
public override string ToString()
string? object.ToString().public bool TryGetComponent<T>(out T component)
T; it is returned in component.Kaskade
public static class Graphics
Graphics).public static void Blit(Texture source, RenderTexture destination)
Kaskade
public sealed class HeaderAttribute
Inherits Attribute
public HeaderAttribute(string text)
public string Text { get; }
Kaskade
public sealed class HideInInspectorAttribute
Inherits Attribute
public HideInInspectorAttribute()
Kaskade
public readonly readonly struct HotReloadContext
Implements IEquatable<HotReloadContext>
public HotReloadContext()
public HotReloadContext(ulong PreviousGeneration, ulong CurrentGeneration)
public ulong CurrentGeneration { get; init; }
public ulong PreviousGeneration { get; init; }
public void Deconstruct(out ulong PreviousGeneration, out ulong CurrentGeneration)
public bool Equals(HotReloadContext other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(HotReloadContext left, HotReloadContext right)
public static bool operator !=(HotReloadContext left, HotReloadContext right)
Kaskade
public sealed class HotStateBuffer
public HotStateBuffer()
public bool TryRead<T>(ulong fieldId, out T value)
public void Write<T>(ulong fieldId, T value)
Kaskade
public interface IGeneratedBehaviourRegistry
IReadOnlyList<BehaviourMetadata> Metadata { get; }
void CaptureState(Behaviour behaviour, HotStateBuffer state)
Behaviour? Create(ulong typeIdLow, ulong typeIdHigh)
JsonNode? GetField(Behaviour behaviour, string name)
null for an unknown field.IReadOnlyList<FieldMetadata> GetFieldMetadata(ulong typeIdLow, ulong typeIdHigh)
void RestoreState(Behaviour behaviour, HotStateBuffer state)
bool SetField(Behaviour behaviour, string name, JsonNode? value)
false for an unknown field or a value that does not fit.Kaskade
public interface IZitoComponent<TSelf> where TSelf : struct, IZitoComponent<TSelf>
ZitoTypeId TypeId { get; }
TSelf FromHandle(ComponentHandle handle)
Kaskade
public static class Input
Input). Nothing is reported
while a menu or the debug overlay has the input.
public static bool cursorLocked { get; set; }
public static Vector2 mouseDelta { get; }
public static Vector2 mousePosition { get; }
Camera screen conversions take.public static Vector2 mouseScrollDelta { get; }
public static Vector2 rawMouseDelta { get; }
public static bool GetKey(Key key)
key is held down this frame.public static bool GetKey(string engineKeyName)
engineKeyName (such as
"KeyE", "Digit1" or "ShiftLeft") is held down.public static bool GetKeyDown(Key key)
key went down this frame (true for one frame per press).public static bool GetKeyDown(string engineKeyName)
engineKeyName went down this frame.public static bool GetKeyUp(Key key)
key was released this frame.public static bool GetKeyUp(string engineKeyName)
engineKeyName was released this frame.public static bool GetMouseButton(MouseButton button)
public static bool GetMouseButton(int button)
button (0 left, 1 right, 2 middle) is held down.public static bool GetMouseButtonDown(MouseButton button)
public static bool GetMouseButtonDown(int button)
button (0 left, 1 right, 2 middle) went down this frame.public static bool GetMouseButtonUp(MouseButton button)
public static bool GetMouseButtonUp(int button)
button (0 left, 1 right, 2 middle) was released this frame.public static bool KeyDown(Key key)
Input.GetKeyDown: whether key went down this frame.public static string KeyName(Key key)
input.key_down takes it).Kaskade
public sealed class KaskadeComponentAttribute
Inherits Attribute
public KaskadeComponentAttribute(string id)
public Guid Id { get; }
Kaskade
public enum Key
Input.KeyName).A = 1
Alpha0 = 28
Alpha1 = 29
Alpha2 = 30
Alpha3 = 31
Alpha4 = 32
Alpha5 = 33
Alpha6 = 34
Alpha7 = 35
Alpha8 = 36
Alpha9 = 37
B = 6
Backspace = 40
C = 7
D = 3
DownArrow = 48
E = 8
Escape = 5
F = 9
F1 = 51
F10 = 58
F2 = 52
F3 = 53
F4 = 54
F5 = 55
F6 = 56
F8 = 57
G = 10
H = 11
I = 12
J = 13
K = 14
L = 15
LeftAlt = 45
LeftArrow = 49
LeftControl = 43
LeftShift = 41
M = 16
N = 17
O = 18
P = 19
Q = 20
R = 21
Return = 38
RightAlt = 46
RightArrow = 50
RightControl = 44
RightShift = 42
S = 2
Space = 4
T = 22
Tab = 39
U = 23
UpArrow = 47
V = 24
W = 0
X = 25
Y = 26
Z = 27
Kaskade
public struct LayerMask
public LayerMask()
public int value
public static int GetMask(params int[] layers)
public static implicit operator int(LayerMask mask)
public static implicit operator LayerMask(int value)
Kaskade
public sealed class Light
Inherits EngineComponent
public Color color { get; set; }
public double innerSpotAngle { get; set; }
public double intensity { get; set; }
public double range { get; set; }
public double spotAngle { get; set; }
public LightType type { get; }
Kaskade
public enum LightType
Directional = 2
Point = 0
Spot = 1
Kaskade
public sealed class Material
Material; every object using it sees
changes, as Unity's sharedMaterial). Values go to its custom shader by name; _Color,
_MainTex, _EmissionColor, _Metallic and _Smoothness also set the
built-in shader's. Values are applied before the next frame renders.
public Color color { get; set; }
_Color.public Texture? mainTexture { get; set; }
_MainTex.public Vector2 mainTextureOffset { get; set; }
_MainTex_ST's offset.public Vector2 mainTextureScale { get; set; }
_MainTex_ST's scale.public string name { get; }
.kmat) or scene name, when known.public Shader? shader { get; set; }
.shader, .hlsl or .fxc file).public void DisableKeyword(string keyword)
public void EnableKeyword(string keyword)
multi_compile / shader_feature).public Color GetColor(int id)
public Color GetColor(string name)
public float GetFloat(int id)
public float GetFloat(string name)
public int GetInt(string name)
public Texture? GetTexture(string name)
public Vector4 GetVector(string name, Vector4 fallback = default(Vector4))
fallback).public bool HasProperty(int id)
public bool HasProperty(string name)
public bool IsKeywordEnabled(string keyword)
public static Material Of(GameObject gameObject)
gameObject's renderers (its model's, all of them).public void SetColor(int id, Color value)
public void SetColor(string name, Color value)
public void SetFloat(int id, double value)
public void SetFloat(string name, double value)
public void SetFloat(string name, float value)
public void SetInt(string name, int value)
SetInt).public void SetInteger(string name, int value)
SetInteger).public void SetMatrix(string name, Matrix4x4 value)
public void SetTexture(string name, Texture value)
public void SetTextureOffset(string name, Vector2 value)
name_ST zw).public void SetTextureScale(string name, Vector2 value)
name_ST xy).public void SetVector(int id, Vector4 value)
public void SetVector(string name, Vector4 value)
public static implicit operator bool(Material? material)
public static implicit operator string(Material material)
public static implicit operator Material(string name)
.kmat) or scene name, to give a renderer.Kaskade
public sealed class MaterialPropertyBlock
public MaterialPropertyBlock()
public bool isEmpty { get; }
public void Clear()
public Color GetColor(int id)
public Color GetColor(string name)
public float GetFloat(int id)
public float GetFloat(string name)
public void SetColor(int id, Color value)
public void SetColor(string name, Color value)
public void SetFloat(int id, double value)
public void SetFloat(string name, double value)
public void SetVector(int id, Vector4 value)
public void SetVector(string name, Vector4 value)
Kaskade
public static class Mathf
public const float Deg2Rad = 0.017453292
public const float Epsilon = 1E-45
public const float Infinity = Infinity
public const float NegativeInfinity = -Infinity
public const float PI = 3.1415927
public const float Rad2Deg = 57.295776
public static double Abs(double value)
public static int Abs(int value)
public static float Abs(float value)
public static double Acos(double f)
public static float Acos(float f)
public static bool Approximately(float a, float b)
public static double Asin(double f)
public static float Asin(float f)
public static double Atan(double f)
public static float Atan(float f)
public static double Atan2(double y, double x)
public static float Atan2(float y, float x)
public static double Ceil(double f)
public static float Ceil(float f)
public static int CeilToInt(double f)
public static double Clamp(double value, double min, double max)
value limited to min..max.public static int Clamp(int value, int min, int max)
value limited to min..max.public static float Clamp(float value, float min, float max)
value limited to min..max.public static double Clamp01(double value)
value limited to 0..1.public static float Clamp01(float value)
value limited to 0..1.public static double Cos(double f)
public static float Cos(float f)
public static double DeltaAngle(double current, double target)
public static float DeltaAngle(float current, float target)
public static double Exp(double power)
public static float Exp(float power)
power.public static double Floor(double f)
public static float Floor(float f)
public static int FloorToInt(double f)
public static double InverseLerp(double a, double b, double value)
value is between a and b (0..1).public static float InverseLerp(float a, float b, float value)
value is between a and b (0..1).public static bool IsPowerOfTwo(int value)
value is a power of two.public static double Lerp(double a, double b, double t)
t of the way from a to b (t clamped to 0..1).public static float Lerp(float a, float b, float t)
t of the way from a to b (t clamped to 0..1).public static double LerpAngle(double a, double b, double t)
public static float LerpAngle(float a, float b, float t)
public static double LerpUnclamped(double a, double b, double t)
t of the way from a to b (t not clamped).public static float LerpUnclamped(float a, float b, float t)
t of the way from a to b (t not clamped).public static double Log(double f)
public static double Log(double f, double p)
public static float Log(float f)
public static float Log(float f, float p)
p.public static double Log10(double f)
public static float Log10(float f)
public static double Max(double a, double b)
public static double Max(params double[] values)
public static int Max(int a, int b)
public static float Max(float a, float b)
public static float Max(params float[] values)
public static double Min(double a, double b)
public static double Min(params double[] values)
public static int Min(int a, int b)
public static float Min(float a, float b)
public static float Min(params float[] values)
public static double MoveTowards(double current, double target, double maxDelta)
current to target by at most maxDelta.public static float MoveTowards(float current, float target, float maxDelta)
current to target by at most maxDelta.public static double MoveTowardsAngle(double current, double target, double maxDelta)
public static float MoveTowardsAngle(float current, float target, float maxDelta)
Mathf.MoveTowards for angles in degrees.public static int NextPowerOfTwo(int value)
value.public static float PerlinNoise(float x, float y)
public static double PingPong(double t, double length)
public static float PingPong(float t, float length)
t bouncing between 0 and length.public static double Pow(double f, double p)
public static float Pow(float f, float p)
f to the power p.public static double Repeat(double t, double length)
public static float Repeat(float t, float length)
t wrapped into 0..length.public static double Round(double f)
public static float Round(float f)
public static int RoundToInt(double f)
public static double Sign(double f)
public static float Sign(float f)
public static double Sin(double f)
public static float Sin(float f)
public static double SmoothDamp(double current, double target, ref double currentVelocity, double smoothTime, double maxSpeed = double.PositiveInfinity, double deltaTime = -1)
public static float SmoothDamp(float current, float target, ref float currentVelocity, float smoothTime, float maxSpeed = float.PositiveInfinity, float deltaTime = -1)
current smoothly towards target (a critically damped spring).public static double SmoothStep(double from, double to, double t)
public static float SmoothStep(float from, float to, float t)
public static double Sqrt(double f)
public static float Sqrt(float f)
public static double Tan(double f)
public static float Tan(float f)
Kaskade
public struct Matrix4x4
Matrix4x4), column-major as shaders read it.public Matrix4x4()
public Matrix4x4(float[] columnMajor)
public float[] Values { get; }
public static Matrix4x4 identity { get; }
public float this[int row, int column] { get; set; }
row, column.public Vector3 MultiplyPoint(Vector3 p)
public static Matrix4x4 TRS(Vector3 position, Quaternion rotation, Vector3 scale)
Matrix4x4.TRS).public static Matrix4x4 operator *(Matrix4x4 a, Matrix4x4 b)
a * b.Kaskade
public sealed class MeshCollider
Inherits Collider
Kaskade
public sealed class MeshRenderer
Inherits EngineComponent
public bool allowOcclusionWhenDynamic { get; set; }
public Bounds bounds { get; }
public bool castShadows { get; set; }
public Material material { get; set; }
.kmat path or a material of the scene; a string
converts). Its Set* calls reach its shader.
public Material[] materials { get; set; }
public bool receiveShadows { get; set; }
public Material sharedMaterial { get; set; }
public Material[] sharedMaterials { get; set; }
public void GetPropertyBlock(MaterialPropertyBlock block)
public void SetPropertyBlock(MaterialPropertyBlock block)
Kaskade
public enum MouseButton
Input.GetMouseButton.Back = 3
Forward = 4
Left = 0
Middle = 2
Right = 1
Kaskade
public static class Network
Network.Host, Network.Connect, or the
console's host / connect ip); every game moves its own player, the others appear
as avatars (the PlayerController's Network Avatar prefab, or a box figure), and the host's
physics is shared on its own.
Network.Send("door", new { open = true }) and, anywhere,
Network.On<DoorData>("door", (data, from) => ...). Reliable by default; they work
offline too (to this game), so one code path serves single player and multiplayer.Network.Set("score", 10) / Network.Get("score", 0):
everyone sees the same, late joiners included; Network.Watch calls back on changes.Network.Players, Network.LocalPlayer,
Network.PlayerJoined, Network.PlayerLeft, Network.Connected, Network.Disconnected.public static bool IsAuthority { get; }
public static bool IsClient { get; }
public static bool IsHost { get; }
public static bool IsOnline { get; }
public static int LocalId { get; }
public static NetworkPlayer? LocalPlayer { get; }
public static int PlayerCount { get; }
public static IReadOnlyList<NetworkPlayer> Players { get; }
public static NetworkRole Role { get; }
public static Action? Connected
public static Action? Disconnected
public static Action<NetworkPlayer>? PlayerJoined
public static Action<NetworkPlayer>? PlayerLeft
public static void Connect(string address)
"192.168.1.5", "host:27015").public static void Disconnect()
public static T Get<T>(string key, T fallback = default(T))
fallback if nobody set it (or it does not fit).public static NetworkPlayer? GetPlayer(int id)
id, or null.public static string? GetState(string key)
Network.Get).public static bool Has(string key)
key.public static void Host(int port = 27015)
public static bool IsLocalPlayer(int index)
index-th player is this game's.public static bool IsTaken(GameObject gameObject)
public static string KeyOf(GameObject gameObject)
Awake, while the object is where the level put it.
public static void Off(string type)
type.public static void Off(string type, Delegate handler)
handler.public static void On(string type, Action<NetworkMessage> handler)
handler for every type message.public static void On<T>(string type, Action<T?, NetworkPlayer?> handler)
handler with the data of every type
message and its sender.public static void On<T>(string type, Action<T?> handler)
handler with the data of every type message.public static int PlayerId(int index)
index-th player's id (see Network.Players).public static string PlayerName(int index)
index-th player's name (see Network.Players).public static GameObject? PlayerObject(int index)
index-th player (see
NetworkPlayer.gameObject).public static int PlayerPing(int index)
index-th player in milliseconds.public static void Send(string type, object? data = null, NetworkTarget to = NetworkTarget.Others, bool reliable = true)
type with data (anything JSON can carry: a
number, a string, a record, an anonymous object, a Vector3) to to.
Reliable messages arrive once each, in time; unreliable ones are for what is sent all the
time anyway. At most about 1 KB of data.
public static void SendTo(NetworkPlayer player, string type, object? data = null, bool reliable = true)
type to one player.public static void SendTo(int playerId, string type, object? data = null, bool reliable = true)
type to one player.public static void Set<T>(string key, T value)
public static void SetState(string key, string value)
Network.Set).public static void Unwatch(string key, Delegate handler)
handler for key.public static void Watch<T>(string key, Action<T?> handler)
handler whenever key's value changes
(whoever changed it), and once now if it is set.Kaskade
public readonly readonly struct NetworkMessage
Network.Send.public NetworkMessage()
public int From { get; }
public string Json { get; }
public NetworkPlayer? Sender { get; }
public string Type { get; }
public T? Read<T>()
T (default if there is none or it does not fit).Kaskade
public sealed record NetworkPlayer
Implements IEquatable<NetworkPlayer>
public NetworkPlayer(int Id, string Name, int Ping, bool IsLocal)
public int Id { get; init; }
public bool IsHost { get; }
public bool IsLocal { get; init; }
public string Name { get; init; }
name).public int Ping { get; init; }
public GameObject? gameObject { get; }
public void Deconstruct(out int Id, out string Name, out int Ping, out bool IsLocal)
public bool Equals(NetworkPlayer? other)
public override bool Equals(object? obj)
public override int GetHashCode()
public override string ToString()
string? object.ToString().public static bool operator ==(NetworkPlayer? left, NetworkPlayer? right)
public static bool operator !=(NetworkPlayer? left, NetworkPlayer? right)
Kaskade
public enum NetworkRole
Client = 2
Host = 1
Offline = 0
Kaskade
public enum NetworkTarget
Network.Send message is for.All = -1
Host = -3
Others = -2
Kaskade
public abstract class Object
GameObject and
Component. As in Unity, a destroyed object compares equal to null
(if (target == null), if (target)), and Object.Destroy,
Object.Instantiate and the Find functions are available everywhere.
public abstract string name { get; set; }
public static void Destroy(Object obj, double delay = 0)
delay seconds. The object goes at the end of the frame.
public static void DestroyImmediate(Object obj)
Object.Destroy (the engine never destroys mid-frame).public static void DontDestroyOnLoad(Object target)
public override bool Equals(object? obj)
bool object.Equals(object? obj).public static T? FindAnyObjectByType<T>() where T : class
public static T? FindFirstObjectByType<T>() where T : class
Object.FindObjectOfType.public static T? FindFirstObjectByType<T>(FindObjectsInactive inactive) where T : class
public static T? FindObjectOfType<T>() where T : class
T, or null.public static T[] FindObjectsByType<T>() where T : class
Object.FindObjectsOfType.public static T[] FindObjectsByType<T>(FindObjectsInactive inactive, FindObjectsSortMode sortMode) where T : class
public static T[] FindObjectsByType<T>(FindObjectsSortMode sortMode) where T : class
public static T[] FindObjectsOfType<T>() where T : class
T (C# behaviours or engine components).public override int GetHashCode()
int object.GetHashCode().public abstract int GetInstanceID()
public static GameObject Instantiate(GameObject original)
original: an object made from a prefab, or a copy of an object of
the scene with its children (as they were authored, at the original's current place).
The copy is returned at once and can be used in the same frame.
public static GameObject Instantiate(GameObject original, Transform? parent, bool instantiateInWorldSpace = false)
original made a child of parent.public static GameObject Instantiate(GameObject original, Vector3 position, Quaternion rotation)
original at a world position and rotation.public static GameObject Instantiate(GameObject original, Vector3 position, Quaternion rotation, Transform? parent)
original at a world position and rotation, under parent.public static T Instantiate<T>(T original) where T : Component
original; returns the copy's matching component.public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation) where T : Component
original at a place; returns the copy's matching component.public override string ToString()
string? object.ToString().public static bool operator ==(Object? left, Object? right)
public static implicit operator bool(Object? value)
value exists (is not null and not destroyed).public static bool operator !=(Object? left, Object? right)
Object.operator ==.Kaskade
public static class Physics
public const int AllLayers = -1
public const double MaxDistance = 100000
public static Vector3 gravity { get; }
public static bool BoxCast(Vector3 center, Vector3 halfExtents, Vector3 direction, out RaycastHit hitInfo, Quaternion? orientation = null, double maxDistance = double.PositiveInfinity, int layerMask = -1)
public static bool CapsuleCast(Vector3 point1, Vector3 point2, double radius, Vector3 direction, out RaycastHit hitInfo, double maxDistance = double.PositiveInfinity, int layerMask = -1)
public static bool CheckBox(Vector3 center, Vector3 halfExtents, Quaternion? orientation = null, int layerMask = -1)
public static bool CheckSphere(Vector3 position, double radius, int layerMask = -1)
public static bool Linecast(Vector3 start, Vector3 end, out RaycastHit hitInfo, int layerMask = -1)
start to end crosses a collider.public static bool Linecast(Vector3 start, Vector3 end, int layerMask = -1)
start to end crosses a collider.public static Collider[] OverlapBox(Vector3 center, Vector3 halfExtents, Quaternion? orientation = null, int layerMask = -1)
public static Collider[] OverlapSphere(Vector3 position, double radius, int layerMask = -1)
public static bool Raycast(Ray ray, out RaycastHit hitInfo, double maxDistance = double.PositiveInfinity, int layerMask = -1)
ray hits a collider; the nearest hit in hitInfo.public static bool Raycast(Ray ray, double maxDistance = double.PositiveInfinity, int layerMask = -1)
ray hits a collider.public static bool Raycast(Vector3 origin, Vector3 direction, out RaycastHit hitInfo, double maxDistance = double.PositiveInfinity, int layerMask = -1)
hitInfo.public static bool Raycast(Vector3 origin, Vector3 direction, double maxDistance = double.PositiveInfinity, int layerMask = -1)
public static RaycastHit[] RaycastAll(Ray ray, double maxDistance = double.PositiveInfinity, int layerMask = -1)
ray hits, nearest first.public static RaycastHit[] RaycastAll(Vector3 origin, Vector3 direction, double maxDistance = double.PositiveInfinity, int layerMask = -1)
public static int RaycastNonAlloc(Vector3 origin, Vector3 direction, RaycastHit[] results, double maxDistance = double.PositiveInfinity, int layerMask = -1)
results; their count.public static bool SphereCast(Vector3 origin, double radius, Vector3 direction, out RaycastHit hitInfo, double maxDistance = double.PositiveInfinity, int layerMask = -1)
public static RaycastHit[] SphereCastAll(Vector3 origin, double radius, Vector3 direction, double maxDistance = double.PositiveInfinity, int layerMask = -1)
public static void SyncTransforms()
Kaskade
public enum PlayState
PlayableDirector is playing (Unity's PlayState).Paused = 0
Playing = 1
Kaskade
public sealed class PlayableDirector
Inherits EngineComponent
[object.director], a .ktimeline), as Unity's
PlayableDirector. Commands take effect on the director's next update.
public double duration { get; }
public bool isFinished { get; }
public double speed { set; }
public PlayState state { get; }
public double time { get; set; }
public void Pause()
public void Play()
public bool SignalPassed(string name)
name was passed during the last update.public void Stop()
Kaskade
public sealed class PlayerController
Inherits EngineComponent
[object.player_controller]): moves its object (the feet)
with collisions, steps, crouching and jumping, from the keys and mouse, and carries the child
camera at the eye. State is as of its last step; changes take effect on its next one.
public Vector3 cameraOffset { get; set; }
public bool customNetworkAvatar { get; set; }
PlayerController.networkAvatar
instead of the default box figure.public float eyeHeight { get; }
public float footstepVolume { get; set; }
public bool footsteps { get; set; }
Assets/Audio/Footsteps).public bool isCrouched { get; }
public bool isCrouching { get; }
public bool isDucking { get; }
public bool isGrounded { get; }
public bool isSprinting { get; }
public float jumpImpulse { get; set; }
public bool lookInput { get; set; }
public float mouseSensitivity { get; set; }
sensitivity).public Vector2 moveInput { get; }
public bool movementInput { get; set; }
public string networkAvatar { get; set; }
.kprefab, project relative) other players are drawn
with when PlayerController.customNetworkAvatar is on: its origin at their feet, turned the
way they face.public float pitch { get; }
public float sprintSpeed { get; set; }
public Vector3 velocity { get; }
public float walkSpeed { get; set; }
public float yaw { get; }
public void Push(Vector3 velocity)
velocity (metres per second) on the next step, as a pusher
does (an upward push lifts it off the ground).public void SetFootstepSounds(string surface, params AudioClip[] clips)
"Default", "Concrete", "Wood",
"Metal", "Grass", "Gravel", "Dirt", "Tile", "Water",
any word of a collider's name, or "Jump" / "Land". One is picked at random each
step; no clips clears the surface (the project's Footsteps folders play again).
public void SetLook(float pitch, float yaw)
pitch and yaw (degrees).public void Teleport(Vector3 position, Quaternion rotation)
position (the feet) facing rotation, dropping its speed.Kaskade
public static class PlayerPrefs
PlayerPrefs. Changes reach the disk about once a second and when the
game ends; PlayerPrefs.Save writes at once.
public static void DeleteAll()
public static void DeleteKey(string key)
key.public static float GetFloat(string key, float defaultValue = 0)
key, or defaultValue.public static int GetInt(string key, int defaultValue = 0)
key, or defaultValue.public static string GetString(string key, string defaultValue = "")
key, or defaultValue.public static bool HasKey(string key)
key.public static void Save()
public static void SetFloat(string key, float value)
key.public static void SetInt(string key, int value)
key.public static void SetString(string key, string value)
key.Kaskade
public readonly readonly struct Quaternion
Implements IEquatable<Quaternion>
public Quaternion()
public Quaternion(double X, double Y, double Z, double W)
public static Quaternion Identity { get; }
public double W { get; init; }
public double X { get; init; }
public double Y { get; init; }
public double Z { get; init; }
public Vector3 eulerAngles { get; }
public static Quaternion identity { get; }
Quaternion.Identity).public Quaternion normalized { get; }
public double w { get; }
public double x { get; }
public double y { get; }
public double z { get; }
public static double Angle(Quaternion a, Quaternion b)
public static Quaternion AngleAxis(double angleDegrees, Vector3 axis)
angleDegrees about axis.public void Deconstruct(out double X, out double Y, out double Z, out double W)
public static double Dot(Quaternion a, Quaternion b)
public bool Equals(Quaternion other)
public override bool Equals(object obj)
public static Quaternion Euler(Vector3 euler)
public static Quaternion Euler(double x, double y, double z)
X * Y * Z): x about X, y about Y,
z about Z. Quaternion.eulerAngles gives the angles back.
public static Quaternion FromToRotation(Vector3 from, Vector3 to)
from to to.public override int GetHashCode()
public Quaternion Inverse()
public static Quaternion Inverse(Quaternion rotation)
rotation.public static Quaternion Lerp(Quaternion a, Quaternion b, double t)
Quaternion.Slerp, t clamped to 0..1).public static Quaternion LookRotation(Vector3 forward, Vector3? up = null)
forward, keeping
up (default world up) as upright as possible.
public static Quaternion RotateTowards(Quaternion from, Quaternion to, double maxDegreesDelta)
from towards to by at most maxDegreesDelta.public static Quaternion Slerp(Quaternion a, Quaternion b, double t)
a to b (t clamped to 0..1).public void ToAngleAxis(out double angle, out Vector3 axis)
public override string ToString()
Quaternion.normalized (a quaternion) would print its own forever.
public static bool operator ==(Quaternion left, Quaternion right)
public static bool operator !=(Quaternion left, Quaternion right)
public static Quaternion operator *(Quaternion a, Quaternion b)
a * b rotates by b first, then by a.public static Vector3 operator *(Quaternion rotation, Vector3 point)
rotation.Kaskade
public static class Random
public static Vector2 insideUnitCircle { get; }
public static Vector3 insideUnitSphere { get; }
public static Vector3 onUnitSphere { get; }
public static Quaternion rotation { get; }
public static float value { get; }
public static Color ColorHSV(float hueMin = 0, float hueMax = 1, float saturationMin = 0, float saturationMax = 1, float valueMin = 0, float valueMax = 1)
public static void InitState(int seed)
seed.public static double Range(double minInclusive, double maxInclusive)
public static int Range(int minInclusive, int maxExclusive)
minInclusive up to (not including) maxExclusive.public static float Range(float minInclusive, float maxInclusive)
Kaskade
public sealed class RangeAttribute
Inherits Attribute
min and max.public RangeAttribute(double min, double max)
min and max.public double Max { get; }
public double Min { get; }
Kaskade
public readonly readonly struct Ray
Implements IEquatable<Ray>
public Ray()
public Ray(Vector3 Origin, Vector3 Direction)
public Vector3 Direction { get; init; }
public Vector3 Origin { get; init; }
public Vector3 direction { get; }
public Vector3 origin { get; }
public void Deconstruct(out Vector3 Origin, out Vector3 Direction)
public bool Equals(Ray other)
public override bool Equals(object obj)
public override int GetHashCode()
public Vector3 GetPoint(double distance)
distance metres along the ray.public override string ToString()
public static bool operator ==(Ray left, Ray right)
public static bool operator !=(Ray left, Ray right)
Kaskade
public readonly readonly struct RaycastHit
public RaycastHit()
public Collider? collider { get; }
public double distance { get; }
RaycastHit.point (metres).public GameObject gameObject { get; }
public Vector3 normal { get; }
RaycastHit.point.public Vector3 point { get; }
public Rigidbody? rigidbody { get; }
public Transform transform { get; }
Kaskade
public struct Rect
public Rect()
public Rect(Rect source)
public Rect(Vector2 position, Vector2 size)
public Rect(double x, double y, double width, double height)
public Rect(float x, float y, float width, float height)
public float height
public float width
public float x
public float y
public float Height { get; set; }
public float Width { get; set; }
public float X { get; set; }
public float Y { get; set; }
public Vector2 center { get; set; }
public Vector2 max { get; set; }
public Vector2 min { get; set; }
public Vector2 position { get; set; }
public Vector2 size { get; set; }
public float xMax { get; set; }
public float xMin { get; set; }
public float yMax { get; set; }
public float yMin { get; set; }
public static Rect zero { get; }
public bool Contains(Vector2 point)
public override bool Equals(object? obj)
bool ValueType.Equals(object? obj).public override int GetHashCode()
int ValueType.GetHashCode().public bool Overlaps(Rect other)
public void Set(float newX, float newY, float newWidth, float newHeight)
public override string ToString()
string? ValueType.ToString().public static bool operator ==(Rect lhs, Rect rhs)
public static bool operator !=(Rect lhs, Rect rhs)
Kaskade
public class RenderTexture
Inherits Texture
RenderTexture): a camera's target, a compute
shader's output (RenderTexture.enableRandomWrite), what materials read by name.
public RenderTexture(int width, int height, int depth = 0, RenderTextureFormat format = RenderTextureFormat.Default)
RenderTexture.Create or first use).public RenderTexture(string name, int width, int height, RenderTextureFormat format = RenderTextureFormat.Default)
public bool enableRandomWrite { get; set; }
RenderTexture.Create).public RenderTextureFormat format { get; }
public int height { get; }
public string name { get; }
rt:<name>).public int width { get; }
public bool Create()
RenderTexture.Release).public bool IsCreated()
public void Release()
Kaskade
public enum RenderTextureFormat
RenderTextureFormat).ARGB32 = 0
ARGBFloat = 2
ARGBHalf = 1
Default = 6
DefaultHDR = 5
RFloat = 3
RGHalf = 4
Kaskade
public static class Resources
Resources): under Assets/Resources, then the project.public static T? Load<T>(string path) where T : class
path (without its extension,
as Unity's, under Assets/Resources; or a project-relative file).
Kaskade
public sealed class Rigidbody
Inherits EngineComponent
public double angularDrag { get; set; }
public Vector3 angularVelocity { get; set; }
public RigidbodyType bodyType { get; }
public bool detectCollisions { get; set; }
public double drag { get; set; }
public double gravityScale { get; set; }
public bool isAwake { get; set; }
public bool isKinematic { get; set; }
public double linearDamping { get; set; }
Rigidbody.drag.public Vector3 linearVelocity { get; set; }
Rigidbody.velocity.public float mass { get; set; }
public Vector3 position { get; set; }
public Quaternion rotation { get; set; }
public bool useGravity { get; set; }
public Vector3 velocity { get; set; }
public void AddExplosionForce(double explosionForce, Vector3 explosionPosition, double explosionRadius, double upwardsModifier = 0, ForceMode mode = ForceMode.Force)
explosionPosition, weaker with distance up to explosionRadius.public void AddForce(Vector3 force, ForceMode mode = ForceMode.Force)
public void AddForce(double x, double y, double z, ForceMode mode = ForceMode.Force)
public void AddForceAtPosition(Vector3 force, Vector3 position, ForceMode mode = ForceMode.Force)
public void AddRelativeForce(Vector3 force, ForceMode mode = ForceMode.Force)
public void AddRelativeTorque(Vector3 torque, ForceMode mode = ForceMode.Force)
public void AddTorque(Vector3 torque, ForceMode mode = ForceMode.Force)
public Vector3 GetPointVelocity(Vector3 worldPoint)
public bool IsSleeping()
public void Move(Vector3 position, Quaternion rotation, float timeStep = 0.016666668)
public void MovePosition(Vector3 position, float timeStep = 0.016666668)
position over the next physics step (keeps its rotation).public void MoveRotation(Quaternion rotation, float timeStep = 0.016666668)
rotation over the next physics step.public void Sleep()
public void WakeUp()
Kaskade
public enum RigidbodyType
Dynamic = 0
Kinematic = 1
Static = 2
Kaskade
public enum ScaleMode
GUI.DrawTexture overload ignores this setting.ScaleAndCrop = 1
ScaleToFit = 2
StretchToFill = 0
Kaskade
public readonly readonly struct Scene
public Scene()
public bool isLoaded { get; }
public string name { get; }
public int rootCount { get; }
public GameObject[] GetRootGameObjects()
public bool IsValid()
Kaskade
public static class SceneManager
public static Scene GetActiveScene()
public static void LoadScene(string scenePath)
scenePath (project relative, e.g. Scenes/Level2.kscene), replacing this one.Kaskade
public static class Screen
public static Vector2 center { get; }
public static int height { get; }
public static int width { get; }
Kaskade
public sealed class SerializeFieldAttribute
Inherits Attribute
public SerializeFieldAttribute()
Kaskade
public sealed class Shader
Shader): a .shader, .hlsl or .fxc.public string path { get; }
public static Shader Find(string path)
path (a project-relative file).public static int PropertyToID(string name)
name.public static void SetGlobalColor(string name, Color value)
public static void SetGlobalFloat(string name, float value)
public static void SetGlobalInt(string name, int value)
public static void SetGlobalMatrix(string name, Matrix4x4 value)
public static void SetGlobalTexture(string name, Texture value)
public static void SetGlobalVector(string name, Vector4 value)
public static implicit operator bool(Shader? shader)
Kaskade
public static class SoftBodies
[object.soft_body]: nodes and beams over the object's mesh). Their
Rigidbody works as usual (velocity, gravity, forces); this switches the rest.
public static void SetRigid(GameObject gameObject, bool rigid)
Kaskade
public enum Space
Self = 1
World = 0
Kaskade
public sealed class SpaceAttribute
Inherits Attribute
public SpaceAttribute(double height = 8)
public double Height { get; }
Kaskade
public sealed class SphereCollider
Inherits Collider
public double radius { get; set; }
Kaskade
public enum TextAnchor
LowerCenter = 7
LowerLeft = 6
LowerRight = 8
MiddleCenter = 4
MiddleLeft = 3
MiddleRight = 5
UpperCenter = 1
UpperLeft = 0
UpperRight = 2
Kaskade
public class Texture
public Texture(string path)
public string path { get; }
rt:<name> for a render texture.public static implicit operator Texture(string path)
Kaskade
public class Texture2D
Inherits Texture
Texture2D).public Texture2D(string path)
Kaskade
public static class Time
public static double DeltaTime { get; }
Time.deltaTime.public static double deltaTime { get; }
FixedUpdate: the physics step), scaled by Time.timeScale.public static double fixedDeltaTime { get; }
public static long frameCount { get; }
public static double realtimeSinceStartup { get; }
public static double time { get; }
public static double timeScale { get; set; }
public static double timeSinceLevelLoad { get; }
public static double unscaledDeltaTime { get; }
Kaskade
public sealed class TooltipAttribute
Inherits Attribute
public TooltipAttribute(string text)
public string Text { get; }
Kaskade
public sealed class Transform
Inherits Component · Implements IEnumerable<Transform>, IEnumerable
Changes are applied when the current update phase ends; reading a value this script set in the same frame gives the value set.
public Vector3 Position { get; set; }
Transform.position.public int childCount { get; }
public Vector3 eulerAngles { get; set; }
public Vector3 forward { get; set; }
public Vector3 localEulerAngles { get; set; }
public Vector3 localPosition { get; set; }
public Quaternion localRotation { get; set; }
public Vector3 localScale { get; set; }
public Vector3 lossyScale { get; }
public Transform? parent { get; set; }
public Vector3 position { get; set; }
public Vector3 right { get; set; }
public Transform root { get; }
public Quaternion rotation { get; set; }
public Vector3 up { get; set; }
public IEnumerable<Transform> Children()
public void DetachChildren()
public Transform? Find(string path)
path ("Child" or "Child/Grandchild"), or null.public Transform GetChild(int index)
index.public IEnumerator<Transform> GetEnumerator()
IEnumerator<Transform> IEnumerable<Transform>.GetEnumerator().public void GetPositionAndRotation(out Vector3 position, out Quaternion rotation)
public Vector3 InverseTransformDirection(Vector3 direction)
public Vector3 InverseTransformPoint(Vector3 point)
public Vector3 InverseTransformVector(Vector3 vector)
public bool IsChildOf(Transform ancestor)
ancestor or below it.public void LookAt(Transform target, Vector3? worldUp = null)
target.public void LookAt(Vector3 worldPosition, Vector3? worldUp = null)
worldPosition.public void Rotate(Vector3 eulers, Space relativeTo = Space.Self)
public void Rotate(Vector3 axis, double angle, Space relativeTo = Space.Self)
angle degrees about axis.public void Rotate(double xAngle, double yAngle, double zAngle, Space relativeTo = Space.Self)
public void RotateAround(Vector3 point, Vector3 axis, double angle)
axis through point by angle degrees.public void SetParent(Transform? newParent, bool worldPositionStays = true)
newParent the parent (null: a root object).public void SetPosition(Vector3 position)
Transform.position.public void SetPositionAndRotation(Vector3 position, Quaternion rotation)
public Vector3 TransformDirection(Vector3 direction)
public Vector3 TransformPoint(Vector3 point)
public Vector3 TransformPoint(double x, double y, double z)
public Vector3 TransformVector(Vector3 vector)
public void Translate(Vector3 translation, Space relativeTo = Space.Self)
translation, along the object's own axes by default.public void Translate(Vector3 translation, Transform relativeTo)
translation along the axes of relativeTo.public void Translate(double x, double y, double z, Space relativeTo = Space.Self)
Kaskade
public static class Ui
ui unit draws): call
during Update or OnGUI each frame. Pixels from the top left of the window.
public static void Alpha(double alpha)
public static bool Clicked(double x, double y, double width, double height)
public static int Font(string path)
Ui.Text; 0 is the default font.public static bool Hovered(double x, double y, double width, double height)
public static void Rect(double x, double y, double width, double height, double radius, Color color)
public static Vector2 Text(double x, double y, double size, Color color, string text, int font = 0, Ui.Align align = Align.Left, double wrap = 0)
y; returns its size in pixels.Kaskade
public enum Ui.Align
Nested in Ui
Ui.Text.Center = 1
Left = 0
Right = 2
Kaskade
public struct Vector2
public Vector2()
public Vector2(double x, double y)
public Vector2(float x, float y)
public float x
public float y
public static Vector2 Down { get; }
public static Vector2 Left { get; }
public static Vector2 One { get; }
public static Vector2 Right { get; }
public static Vector2 Up { get; }
public float X { get; set; }
public float Y { get; set; }
public static Vector2 Zero { get; }
public static Vector2 down { get; }
public static Vector2 left { get; }
public readonly double magnitude { get; }
public readonly Vector2 normalized { get; }
public static Vector2 one { get; }
public static Vector2 right { get; }
public readonly double sqrMagnitude { get; }
public static Vector2 up { get; }
public static Vector2 zero { get; }
public override bool Equals(object? obj)
bool ValueType.Equals(object? obj).public override int GetHashCode()
int ValueType.GetHashCode().public override string ToString()
string? ValueType.ToString().public static Vector2 operator +(Vector2 a, Vector2 b)
public static Vector2 operator /(Vector2 a, double d)
public static Vector2 operator /(Vector2 a, float d)
public static bool operator ==(Vector2 a, Vector2 b)
public static bool operator !=(Vector2 a, Vector2 b)
public static Vector2 operator *(Vector2 a, double d)
public static Vector2 operator *(Vector2 a, float d)
public static Vector2 operator *(double d, Vector2 a)
public static Vector2 operator -(Vector2 a, Vector2 b)
Kaskade
public readonly readonly struct Vector3
Implements IEquatable<Vector3>
public Vector3()
public Vector3(double X, double Y, double Z)
public static Vector3 Back { get; }
public static Vector3 Down { get; }
public static Vector3 Forward { get; }
public static Vector3 Left { get; }
public double Length { get; }
public static Vector3 One { get; }
public static Vector3 Right { get; }
public static Vector3 Up { get; }
public double X { get; init; }
public double Y { get; init; }
public double Z { get; init; }
public static Vector3 Zero { get; }
public static Vector3 back { get; }
public static Vector3 down { get; }
public static Vector3 forward { get; }
public static Vector3 left { get; }
public double magnitude { get; }
Vector3.Length).public static Vector3 negativeInfinity { get; }
public Vector3 normalized { get; }
public static Vector3 one { get; }
public static Vector3 positiveInfinity { get; }
public static Vector3 right { get; }
public double sqrMagnitude { get; }
Vector3.Length for comparisons.public double this[int index] { get; }
index (0 = X, 1 = Y, 2 = Z).public static Vector3 up { get; }
public double x { get; }
public double y { get; }
public double z { get; }
public static Vector3 zero { get; }
public static double Angle(Vector3 from, Vector3 to)
public static Vector3 ClampMagnitude(Vector3 value, double maxLength)
value shortened to at most maxLength.public static Vector3 Cross(Vector3 a, Vector3 b)
public void Deconstruct(out double X, out double Y, out double Z)
public static double Distance(Vector3 a, Vector3 b)
public static double Dot(Vector3 a, Vector3 b)
public bool Equals(Vector3 other)
public override bool Equals(object obj)
public override int GetHashCode()
public static Vector3 Lerp(Vector3 a, Vector3 b, double t)
t of the way from a to b (t clamped to 0..1).public static Vector3 LerpUnclamped(Vector3 a, Vector3 b, double t)
Vector3.Lerp but t is not clamped.public static double Magnitude(Vector3 value)
value.public static Vector3 Max(Vector3 a, Vector3 b)
public static Vector3 Min(Vector3 a, Vector3 b)
public static Vector3 MoveTowards(Vector3 current, Vector3 target, double maxDistanceDelta)
current towards target by at most maxDistanceDelta.public static Vector3 Normalize(Vector3 value)
value.public static Vector3 Project(Vector3 value, Vector3 onNormal)
value projected onto the direction onNormal.public static Vector3 ProjectOnPlane(Vector3 value, Vector3 planeNormal)
value projected onto the plane with normal planeNormal.public static Vector3 Reflect(Vector3 direction, Vector3 normal)
direction reflected off the plane with normal normal.public static Vector3 RotateTowards(Vector3 current, Vector3 target, double maxRadiansDelta, double maxMagnitudeDelta)
current towards target by at most maxRadiansDelta, changing its length by at most maxMagnitudeDelta.public static Vector3 Scale(Vector3 a, Vector3 b)
public static double SignedAngle(Vector3 from, Vector3 to, Vector3 axis)
from to to, signed by the turn about axis.public static Vector3 Slerp(Vector3 a, Vector3 b, double t)
public static Vector3 SmoothDamp(Vector3 current, Vector3 target, ref Vector3 currentVelocity, double smoothTime, double maxSpeed = double.PositiveInfinity, double deltaTime = -1)
current smoothly towards target (a critically damped spring).public static double SqrMagnitude(Vector3 value)
value.public override string ToString()
string? ValueType.ToString().public static Vector3 operator +(Vector3 left, Vector3 right)
public static Vector3 operator /(Vector3 value, double scale)
public static bool operator ==(Vector3 left, Vector3 right)
public static bool operator !=(Vector3 left, Vector3 right)
public static Vector3 operator *(Vector3 a, Vector3 b)
Vector3.Scale).public static Vector3 operator *(Vector3 value, double scale)
public static Vector3 operator *(double scale, Vector3 value)
public static Vector3 operator -(Vector3 left, Vector3 right)
public static Vector3 operator -(Vector3 value)
Kaskade
public readonly readonly struct Vector4
Implements IEquatable<Vector4>
Vector4): shader values, colours, tiling.public Vector4()
public Vector4(float x, float y, float z, float w)
Vector4): shader values, colours, tiling.public static Vector4 one { get; }
public float this[int index] { get; }
public float w { get; init; }
public float x { get; init; }
public float y { get; init; }
public float z { get; init; }
public static Vector4 zero { get; }
public void Deconstruct(out float x, out float y, out float z, out float w)
public bool Equals(Vector4 other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static Vector4 operator +(Vector4 a, Vector4 b)
public static bool operator ==(Vector4 left, Vector4 right)
public static implicit operator Vector4(Color c)
public static implicit operator Vector4(Vector2 v)
public static implicit operator Vector4(Vector3 v)
public static implicit operator Vector3(Vector4 v)
public static bool operator !=(Vector4 left, Vector4 right)
public static Vector4 operator *(Vector4 a, float s)
public static Vector4 operator -(Vector4 a, Vector4 b)
Kaskade
public sealed class Vehicle
Vehicle.Drive or Vehicle.SetControls takes
the controls from the keyboard until Vehicle.ReleaseControls. Every number of the car
can be changed by its path in the .kveh with Vehicle.Set
("brakes.bias", "axle.1.suspension.arb_rate", "driveline.rear.kind").
public Vehicle(GameObject gameObject)
public Vector3 Acceleration { get; }
public Vector3 AngularVelocity { get; }
public double ClutchEngagement { get; }
public double ClutchSlip { get; }
public double ClutchTorque { get; }
public bool EngineRunning { get; }
public double EngineTorque { get; }
public string Error { get; }
public int ForwardGearCount { get; }
public double Fuel { get; }
public double FuelConsumedKg { get; }
public GameObject GameObject { get; }
public int Gear { get; }
public double GearRatio { get; }
public bool IsShifting { get; }
public bool IsSimulated { get; }
public bool Limiter { get; }
public Vector3 LinearVelocity { get; }
public bool ParkingBrakeEngaged { get; }
public double Rpm { get; }
public bool ScriptControlsActive { get; }
public double Speed { get; }
public double SpeedKmh { get; }
public bool StabilityControlActive { get; }
public bool StarterActive { get; }
public double SteeringAngle { get; }
public double SteeringTorque { get; }
public double Throttle { get; }
public bool TractionControlActive { get; }
public VehicleTuning Tune { get; }
public int WheelCount { get; }
public void Drive(double throttle, double brake, double steer)
public string? GetSetting(string path)
.kveh path.public IReadOnlyDictionary<string, string> GetSettings()
public WheelState GetWheel(int index)
public IReadOnlyList<WheelState> GetWheels()
public void Hold(double brake = 1, double handbrake = 1)
public void Load(string file)
.kveh; the body stays.public void ReleaseControls()
public void ResetState()
public void Set(string path, bool value)
.kveh path.public void Set(string path, double value)
.kveh path.public void Set(string path, string value)
.kveh path; the car rebuilds next step.public void SetControls(VehicleInput input)
public void SetControls(double throttle, double brake, double clutch, double steer, double handbrake, bool starter)
public void SetIgnition(bool start)
public void SetMany(IEnumerable<KeyValuePair<string, string>> values)
public void SetParkingBrake(bool engaged)
public void SetPunctured(int wheel, bool punctured)
public void Shift(int gear)
public void ShiftDown()
public void ShiftNeutral()
public void ShiftReverse()
public void ShiftUp()
public void StartEngine()
public void StopEngine()
public bool TryGetNumber(string path, out double value)
public bool TryGetSnapshot(out VehicleSnapshot? snapshot)
public bool TryGetSwitch(string path, out bool value)
public bool TryGetWheel(int index, out WheelState wheel)
Kaskade
public sealed class VehicleAxleTuning
public double AntiRollRate { get; set; }
public double DroopHeight { get; set; }
public double LongitudinalPosition { get; set; }
public double PressurePa { get; set; }
public double SpringPreload { get; set; }
public double SpringRate { get; set; }
public double SteeringGain { get; set; }
public bool Steers { get; set; }
public double SuspensionTravel { get; set; }
public double Track { get; set; }
public double UnsprungMass { get; set; }
public double WheelInertia { get; set; }
Kaskade
public static class VehicleExtensions
public static Vehicle Vehicle(GameObject gameObject)
Kaskade
public readonly readonly struct VehicleInput
Implements IEquatable<VehicleInput>
public VehicleInput()
public VehicleInput(double Throttle = 0, double Brake = 0, double Clutch = 0, double Steer = 0, double Handbrake = 0, bool Starter = false)
public double Brake { get; init; }
public double Clutch { get; init; }
public double Handbrake { get; init; }
public bool Starter { get; init; }
public double Steer { get; init; }
public double Throttle { get; init; }
public void Deconstruct(out double Throttle, out double Brake, out double Clutch, out double Steer, out double Handbrake, out bool Starter)
public bool Equals(VehicleInput other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(VehicleInput left, VehicleInput right)
public static bool operator !=(VehicleInput left, VehicleInput right)
Kaskade
public sealed class VehicleSnapshot
public Vector3 AngularVelocity { get; }
public double ClutchEngagement { get; }
public double ClutchSlip { get; }
public double ClutchTorque { get; }
public bool EngineRunning { get; }
public double EngineTorque { get; }
public string Error { get; }
public int ForwardGearCount { get; }
public double Fuel { get; }
public double FuelConsumedKg { get; }
public int Gear { get; }
public double GearRatio { get; }
public double GroundSpeedKmh { get; }
public int GroundedWheelCount { get; }
public bool IsGrounded { get; }
public bool IsShifting { get; }
public bool Limiter { get; }
public Vector3 LinearVelocity { get; }
public Vector3 LocalAcceleration { get; }
public bool ParkingBrakeEngaged { get; }
public double Rpm { get; }
public bool ScriptControlsActive { get; }
public double Speed { get; }
public double SpeedKmh { get; }
public bool StabilityControlActive { get; }
public bool StarterActive { get; }
public double SteeringAngle { get; }
public double SteeringTorque { get; }
public double Throttle { get; }
public bool TractionControlActive { get; }
public IReadOnlyList<WheelState> Wheels { get; }
Kaskade
public sealed class VehicleTuning
public bool Abs { get; set; }
public double Ackermann { get; set; }
public bool AutomaticClutch { get; set; }
public bool AutomaticGearbox { get; set; }
public double BrakeBias { get; set; }
public double BrakeTorque { get; set; }
public bool CanStall { get; set; }
public double ClutchEngageRpm { get; set; }
public double ClutchLockRpm { get; set; }
public double ClutchMaxTorque { get; set; }
public double DragArea { get; set; }
public double EngineInertia { get; set; }
public double FinalDrive { get; set; }
public double FrontLiftArea { get; set; }
public double FuelCapacity { get; }
public bool FuelConsumption { get; set; }
public double HandbrakeTorque { get; set; }
public double IdleRpm { get; set; }
public double LimiterRpm { get; set; }
public double Mass { get; set; }
public double RearLiftArea { get; set; }
public double ReverseRatio { get; set; }
public double ShiftDownRpm { get; set; }
public double ShiftTime { get; set; }
public double ShiftUpRpm { get; set; }
public bool StabilityControl { get; set; }
public double StallRpm { get; set; }
public double StarterTorque { get; set; }
public double SteeringAssist { get; set; }
public double SteeringLockDegrees { get; set; }
public double SteeringRatio { get; set; }
public bool TractionControl { get; set; }
public VehicleAxleTuning Axle(int index)
public void SetForwardGearRatios(params double[] ratios)
Kaskade
public sealed class WaitForEndOfFrame
Inherits YieldInstruction
public WaitForEndOfFrame()
Kaskade
public sealed class WaitForFixedUpdate
Inherits YieldInstruction
public WaitForFixedUpdate()
Kaskade
public sealed class WaitForSeconds
Inherits YieldInstruction
seconds of game time (scaled by Time.timeScale).public WaitForSeconds(double seconds)
seconds of game time (scaled by Time.timeScale).Kaskade
public sealed class WaitForSecondsRealtime
Inherits CustomYieldInstruction
seconds of real time (not scaled).public WaitForSecondsRealtime(double seconds)
seconds of real time (not scaled).public override bool keepWaiting { get; }
Kaskade
public sealed class WaitUntil
Inherits CustomYieldInstruction
predicate returns true.public WaitUntil(Func<bool> predicate)
predicate returns true.public override bool keepWaiting { get; }
Kaskade
public sealed class WaitWhile
Inherits CustomYieldInstruction
predicate returns true.public WaitWhile(Func<bool> predicate)
predicate returns true.public override bool keepWaiting { get; }
Kaskade
public static class Weather
engine.weather_get / engine.weather_set). Changes apply on the next frame.
public static bool rainEnabled { get; set; }
public static float rainIntensity { get; set; }
public static float rainSoundVolume { get; set; }
public static float wetness { get; set; }
public static Vector2 wind { get; set; }
public static float Get(string name)
public static void Set(string name, float value)
public static void SetReverb(float roomSize, float damping, float wet)
Kaskade
public readonly readonly struct WheelState
Vehicle as of the last physics step.public WheelState()
public bool AbsActive { get; init; }
public double AligningMoment { get; init; }
public double BrakeTorque { get; init; }
public double CamberDegrees { get; init; }
public double Compression { get; init; }
public Vector3 ContactPoint { get; init; }
public double ForwardForce { get; init; }
public bool IsDriven { get; init; }
public bool IsPunctured { get; init; }
public double Load { get; init; }
public bool OnGround { get; init; }
public bool RimContact { get; init; }
public double SideForce { get; init; }
public double SlipAngle { get; init; }
public double SlipRatio { get; init; }
public double SlipSpeed { get; init; }
public double Spin { get; init; }
public double SpinAngle { get; init; }
public double SteerAngle { get; init; }
public int Surface { get; init; }
public double SuspensionForce { get; init; }
public double ToeDegrees { get; init; }
Kaskade
public abstract class YieldInstruction
WaitForSeconds, ...).Kaskade
public readonly readonly struct ZitoTypeId
Implements IEquatable<ZitoTypeId>
public ZitoTypeId()
public ZitoTypeId(ulong Low, ulong High)
public ulong High { get; init; }
public ulong Low { get; init; }
public void Deconstruct(out ulong Low, out ulong High)
public bool Equals(ZitoTypeId other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(ZitoTypeId left, ZitoTypeId right)
public static bool operator !=(ZitoTypeId left, ZitoTypeId right)
Kaskade
public static class AnimatorApi
public static EngineValue Bone(GameObject? entity, string bone)
animator.bone (engine function engine.animator_bone).public static void CrossFade(GameObject? entity, string state, double duration, int layer = 0)
entity (or the first under it) to state over duration seconds.public static void PlayLayer(GameObject? entity, string state, int layer)
animator.play_layer (engine function engine.animator_play).public static void ResetTrigger(GameObject? entity, string name)
animator.reset_trigger (engine function engine.animator_reset_trigger).public static void SetBonePosition(GameObject? entity, string bone, double x, double y, double z, double weight)
animator.set_bone_position (engine function engine.animator_set_bone_position).public static void SetBoneRotation(GameObject? entity, string bone, Quaternion rotation, double weight = 1)
weight.public static void SetBoneRotation(GameObject? entity, string bone, double x, double y, double z, double w, double weight)
animator.set_bone_rotation (engine function engine.animator_set_bone_rotation).public static void SetBool(GameObject? entity, string name, bool value)
animator.set_bool (engine function engine.animator_set_bool).public static void SetFloat(GameObject? entity, string name, double value)
animator.set_float (engine function engine.animator_set_float).public static void SetInt(GameObject? entity, string name, int value)
animator.set_int (engine function engine.animator_set_int).public static void SetSpeed(GameObject? entity, double speed)
animator.set_speed (engine function engine.animator_set_speed).public static void SetTrigger(GameObject? entity, string name)
animator.set_trigger (engine function engine.animator_set_trigger).public static string State(GameObject? entity, int layer = 0)
layer.public static bool TryGetBone(GameObject? entity, string bone, out BonePose pose)
entity (or the first under it) as its clips posed it on
the last frame, before scripts' overrides; false when there is no such bone.
Kaskade
public static class ApplicationApi
public static void Quit()
application.quit (engine function engine.request_quit).public static int ScreenHeight()
application.screen_height (engine function engine.screen_height).public static int ScreenWidth()
application.screen_width (engine function engine.screen_width).Kaskade
public static class AudioApi
public static void PlayMusic(string clip, double volume)
audio.play_music (engine function engine.play_music).public static void StopMusic()
audio.stop_music (engine function engine.stop_music).Kaskade
public static class CameraApi
public static EngineValue ScreenPointToRay(Vector2 screenPosVec2)
camera.screen_point_to_ray (engine function engine.camera_screen_point_to_ray).public static EngineValue ScreenPointToWorldPos(Vector2 screenPosVec2, double maxDist)
camera.screen_point_to_world_pos (engine function engine.camera_screen_point_to_world_pos).public static EngineValue ScreenToWorldPoint(Vector2 screenPosVec2, double distance)
camera.screen_to_world_point (engine function engine.camera_screen_to_world_point).public static void SetFov(GameObject? cameraEntity, double fovDegrees)
camera.set_fov (engine function engine.camera_set_fov).public static EngineValue WorldToScreenPoint(Vector3 worldPosVec3)
camera.world_to_screen_point (engine function engine.camera_world_to_screen_point).Kaskade
public static class CollisionApi
public static bool IsTrigger(GameObject? entity)
collision.is_trigger (engine function engine.collision_is_trigger).public static Vector3 LastContactNormal(GameObject? entity)
collision.last_contact_normal (engine function engine.collision_last_contact_normal).public static Vector3 LastContactPoint(GameObject? entity)
collision.last_contact_point (engine function engine.collision_last_contact_point).public static int OverlapCount(GameObject? triggerEntity)
collision.overlap_count (engine function engine.collision_overlap_count).public static EngineValue OverlapEntityAt(GameObject? triggerEntity, int index)
collision.overlap_entity_at (engine function engine.collision_overlap_entity_at).public static void SetTrigger(GameObject? entity, bool isTrigger)
collision.set_trigger (engine function engine.collision_set_trigger).Kaskade
public static class ComponentApi
public static EngineValue Add(GameObject? entity, string typeName)
component.add (engine function engine.component_add).public static void AddKind(GameObject? entity, string kind)
component.add_kind (engine function engine.add_component_kind).public static bool Alive(EngineValue handle)
component.alive (engine function engine.component_alive).public static bool Enabled(EngineValue handle)
component.enabled (engine function engine.component_enabled).public static EngineValue Get(GameObject? entity, string typeName)
component.get (engine function engine.get_component).public static EngineValue GetAllInChildren(GameObject? entity, string typeName)
component.get_all_in_children (engine function engine.component_get_all_in_children).public static EngineValue GetInChildren(GameObject? entity, string typeName)
component.get_in_children (engine function engine.component_get_in_children).public static EngineValue GetInParent(GameObject? entity, string typeName)
component.get_in_parent (engine function engine.component_get_in_parent).public static bool Has(EngineValue handle, string field)
component.has (engine function engine.has_field).public static GameObject? Owner(EngineValue handle)
component.owner (engine function engine.component_owner).public static EngineValue Property(GameObject? entity, string typeName, string property)
component.property (engine function engine.component_property).public static EngineValue Read(EngineValue handle, string field)
component.read (engine function engine.get_field).public static void Remove(EngineValue handle)
component.remove (engine function engine.remove_component).public static void RemoveKind(GameObject? entity, string typeName)
component.remove_kind (engine function engine.remove_component_kind).public static void SetProperty(GameObject? entity, string typeName, string property, EngineValue value)
component.set_property (engine function engine.set_component_property).public static bool TypeMatches(EngineValue comp, string typeName)
component.type_matches (engine function engine.component_type_matches).public static void Write(EngineValue handle, string field, EngineValue value)
component.write (engine function engine.set_field).Kaskade
public static class ComputeApi
public static EngineValue Buffer(int count, int stride)
compute.buffer (engine function engine.compute_buffer_create).public static void Dispatch(string path, string kernel, int x, int y, int z, EngineValue values)
compute.dispatch (engine function engine.compute_dispatch).public static EngineValue KernelSize(string path, string kernel)
compute.kernel_size (engine function engine.compute_kernel_size).public static void Release(EngineValue buffer)
compute.release (engine function engine.compute_buffer_release).public static void Request(EngineValue buffer)
compute.request (engine function engine.compute_buffer_request).public static void SetData(EngineValue buffer, EngineValue floats)
compute.set_data (engine function engine.compute_buffer_set_data).public static void SetDataInt(EngineValue buffer, EngineValue ints)
compute.set_data_int (engine function engine.compute_buffer_set_data_int).Kaskade
public static class ControllerApi
public static GameObject? GroundEntity(GameObject? entity)
controller.ground_entity (engine function engine.controller_ground_entity).public static Vector3 GroundNormal(GameObject? entity)
controller.ground_normal (engine function engine.controller_ground_normal).public static bool IsGrounded(GameObject? entity)
controller.is_grounded (engine function engine.controller_is_grounded).public static EngineValue MoveAndSlide(GameObject? entity, Vector3 motionDeltaVec3)
controller.move_and_slide (engine function engine.controller_move_and_slide).public static void SetSlopeLimit(GameObject? entity, double maxSlopeDegrees)
controller.set_slope_limit (engine function engine.controller_set_slope_limit).public static void SetStepHeight(GameObject? entity, double stepHeight)
controller.set_step_height (engine function engine.controller_set_step_height).public static void Teleport(GameObject? entity, Vector3 position, Quaternion rotation)
controller.teleport (engine function engine.player_teleport).Kaskade
public static class DebugApi
public static void DrawLine(Vector3 startVec3, Vector3 endVec3, Color colorRgb, double duration)
debug.draw_line (engine function engine.debug_draw_line).public static void DrawWireShape(int shapeType, Vector3 positionVec3, Vector3 extentsVec3, Quaternion rotationQuat, Color colorRgb, double duration)
debug.draw_wire_shape (engine function engine.debug_draw_wire_shape).public static void Error(string message)
debug.error (engine function engine.debug_error).public static void Log(string message)
debug.log (engine function engine.debug_log).public static void Warn(string message)
debug.warn (engine function engine.debug_warn).Kaskade
public static class DirectorApi
public static bool Finished(GameObject? entity)
director.finished (engine function engine.director_finished).public static bool IsPlaying(GameObject? entity)
director.is_playing (engine function engine.director_is_playing).public static void Pause(GameObject? entity)
director.pause (engine function engine.director_pause).public static void Play(GameObject? entity)
director.play (engine function engine.director_play).public static void SetSpeed(GameObject? entity, double speed)
director.set_speed (engine function engine.director_set_speed).public static void SetTime(GameObject? entity, double time)
director.set_time (engine function engine.director_set_time).public static bool Signal(GameObject? entity, string name)
director.signal (engine function engine.director_signal).public static void Stop(GameObject? entity)
director.stop (engine function engine.director_stop).Kaskade
public static class EngineApi
public static EngineValue Call(string name, params EngineValue[] arguments)
engine.* function by name, as Zito scripts can.public static EngineValue ComponentAt(GameObject? entity, int index)
engine.component_at (engine function engine.component_at).public static string ComponentName(EngineValue component)
engine.component_name (engine function engine.component_name).public static string ComponentTypeName(EngineValue component)
engine.component_type_name (engine function engine.component_type_name).public static GameObject? CreateGameObject(Scene scene, string name)
engine.create_game_object (engine function engine.create_game_object).public static GameObject? ObjectAt(int index)
engine.object_at (engine function engine.object_at).public static void PlaySound(string clip, double x, double y, double z, double volume)
engine.play_sound (engine function engine.play_sound).public static string Renderer()
engine.renderer (engine function engine.renderer).public static void RotateEuler(GameObject? entity, double x, double y, double z)
engine.rotate_euler (engine function engine.rotate_euler).public static EngineValue SelfComponent()
engine.self_component (engine function engine.self_component).public static void SetComponentEnabled(EngineValue component, bool enabled)
engine.set_component_enabled (engine function engine.set_component_enabled).public static void SetLocalPosition(GameObject? entity, double x, double y, double z)
engine.set_local_position (engine function engine.set_local_position).public static void SetLocalRotationEuler(GameObject? entity, double x, double y, double z)
engine.set_local_rotation_euler (engine function engine.set_local_rotation_euler).public static void SetLocalRotationQuaternion(GameObject? entity, double x, double y, double z, double w)
engine.set_local_rotation_quaternion (engine function engine.set_local_rotation_quaternion).public static void SetLocalScale(GameObject? entity, double x, double y, double z)
engine.set_local_scale (engine function engine.set_local_scale).public static void SetTimeOfDay(double hour)
engine.set_time_of_day (engine function engine.set_time_of_day).public static void SetTimeOfDayEnabled(bool enabled)
engine.set_time_of_day_enabled (engine function engine.set_time_of_day_enabled).public static void SetWorldPosition(GameObject? entity, double x, double y, double z)
engine.set_world_position (engine function engine.set_world_position).public static void SetWorldRotationEuler(GameObject? entity, double x, double y, double z)
engine.set_world_rotation_euler (engine function engine.set_world_rotation_euler).public static void SetWorldRotationQuaternion(GameObject? entity, double x, double y, double z, double w)
engine.set_world_rotation_quaternion (engine function engine.set_world_rotation_quaternion).public static void SetWorldScale(GameObject? entity, double x, double y, double z)
engine.set_world_scale (engine function engine.set_world_scale).public static EngineValue SettingsDisplay()
engine.settings_display (engine function engine.settings_display).public static EngineValue SettingsGet(string key)
engine.settings_get (engine function engine.settings_get).public static bool TimeOfDayEnabled()
engine.time_of_day_enabled (engine function engine.time_of_day_enabled).public static void Translate(GameObject? entity, double x, double y, double z)
engine.translate (engine function engine.translate).public static void UiImage(string path, double x, double y, double w, double h, double radius, Color tint, bool fit)
engine.ui_image (engine function engine.ui_image).public static EngineValue UiMouse()
engine.ui_mouse (engine function engine.ui_mouse).public static EngineValue UiScreen()
engine.ui_screen (engine function engine.ui_screen).public static void WeatherSet(string name, double value)
engine.weather_set (engine function engine.weather_set).Kaskade
public static class EntityApi
public static bool ActiveInHierarchy(GameObject? entityHandle)
entity.active_in_hierarchy (engine function engine.active_in_hierarchy).public static bool ActiveSelf(GameObject? entityHandle)
entity.active_self (engine function engine.active_self).public static bool Alive(GameObject? entityHandle)
entity.alive (engine function engine.alive).public static GameObject? ChildAt(GameObject? entityHandle, int index)
entity.child_at (engine function engine.child_at).public static int ChildCount(GameObject? entityHandle)
entity.child_count (engine function engine.child_count).public static void ClearParent(GameObject? child, bool keepWorldTransform)
entity.clear_parent (engine function engine.clear_parent).public static void Destroy(GameObject? entityHandle)
entity.destroy (engine function engine.destroy).public static EngineValue FindAllByTag(string tag)
entity.find_all_by_tag (engine function engine.find_all_by_tag).public static GameObject? FindByTag(string tag)
entity.find_by_tag (engine function engine.find_by_tag).public static GameObject? FindDescendant(EngineValue rootHandle, string name)
entity.find_descendant (engine function engine.find_descendant).public static GameObject? Instantiate(GameObject? entity, Vector3 positionVec3, Quaternion rotationQuat)
entity.instantiate (engine function engine.instantiate_object).public static int Layer(GameObject? entityHandle)
entity.layer (engine function engine.entity_layer).public static string Name(GameObject? entityHandle)
entity.name (engine function engine.entity_name).public static GameObject? Parent(GameObject? entityHandle)
entity.parent (engine function engine.parent).public static bool PendingDestroy(GameObject? entityHandle)
entity.pending_destroy (engine function engine.pending_destroy).public static GameObject? Root(GameObject? entityHandle)
entity.root (engine function engine.entity_root).public static Scene Scene(GameObject? entityHandle)
entity.scene (engine function engine.entity_scene).public static void SetActive(GameObject? entityHandle, bool active)
entity.set_active (engine function engine.set_active).public static void SetLayer(GameObject? entityHandle, int layerIndex)
entity.set_layer (engine function engine.set_entity_layer).public static void SetName(GameObject? entityHandle, string name)
entity.set_name (engine function engine.set_entity_name).public static void SetParent(GameObject? child, GameObject? parentEntity, bool keepWorldTransform)
entity.set_parent (engine function engine.set_parent).public static void SetTag(GameObject? entityHandle, string tag)
entity.set_tag (engine function engine.set_entity_tag).public static GameObject? SpawnPrefab(string prefabPath)
entity.spawn_prefab (engine function engine.spawn_prefab).public static GameObject? SpawnPrefabAt(string prefabPath, Vector3 positionVec3, Quaternion rotationQuat)
entity.spawn_prefab_at (engine function engine.spawn_prefab_at).public static string Tag(GameObject? entityHandle)
entity.tag (engine function engine.entity_tag).Kaskade
public static class GraphicsApi
public static void Blit(string source, string destination)
graphics.blit (engine function engine.graphics_blit).public static string ProjectPath()
graphics.project_path (engine function engine.application_project_path).Kaskade
public static class GuiApi
public static void Box(double x, double y, double w, double h, string text)
gui.box (engine function engine.gui_box).public static bool Button(double x, double y, double w, double h, string text)
gui.button (engine function engine.gui_button).public static void Fade(double alpha)
gui.fade (engine function engine.gui_fade).public static double HorizontalScrollbar(double x, double y, double w, double h, double value, double size, double leftVal, double rightVal)
gui.horizontal_scrollbar (engine function engine.gui_horizontal_scrollbar).public static double HorizontalSlider(double x, double y, double w, double h, double value, double leftVal, double rightVal)
gui.horizontal_slider (engine function engine.gui_horizontal_slider).public static void Label(double x, double y, double w, double h, string text)
gui.label (engine function engine.gui_label).public static string PasswordField(double x, double y, double w, double h, string text, string mask)
gui.password_field (engine function engine.gui_password_field).public static bool RepeatButton(double x, double y, double w, double h, string text)
gui.repeat_button (engine function engine.gui_repeat_button).public static void SetBackgroundColor(double r, double g, double b, double a)
gui.set_background_color (engine function engine.gui_set_background_color).public static void SetColor(double r, double g, double b, double a)
gui.set_color (engine function engine.gui_set_color).public static void SetContentColor(double r, double g, double b, double a)
gui.set_content_color (engine function engine.gui_set_content_color).public static void SetEnabled(bool enabled)
gui.set_enabled (engine function engine.gui_set_enabled).public static string TextArea(double x, double y, double w, double h, string text)
gui.text_area (engine function engine.gui_text_area).public static string TextField(double x, double y, double w, double h, string text)
gui.text_field (engine function engine.gui_text_field).public static bool Toggle(double x, double y, double w, double h, bool value, string text)
gui.toggle (engine function engine.gui_toggle).public static double VerticalScrollbar(double x, double y, double w, double h, double value, double size, double topVal, double bottomVal)
gui.vertical_scrollbar (engine function engine.gui_vertical_scrollbar).public static double VerticalSlider(double x, double y, double w, double h, double value, double topVal, double bottomVal)
gui.vertical_slider (engine function engine.gui_vertical_slider).Kaskade
public static class GuilayoutApi
public static void BeginArea(double x, double y, double w, double h)
guilayout.begin_area (engine function engine.guilayout_begin_area).public static void BeginHorizontal()
guilayout.begin_horizontal (engine function engine.guilayout_begin_horizontal).public static EngineValue BeginScrollView(Vector2 scrollPosVec2, double w, double h)
guilayout.begin_scroll_view (engine function engine.guilayout_begin_scroll_view).public static void BeginVertical()
guilayout.begin_vertical (engine function engine.guilayout_begin_vertical).public static void Box(string text)
guilayout.box (engine function engine.guilayout_box).public static bool Button(string text)
guilayout.button (engine function engine.guilayout_button).public static void EndArea()
guilayout.end_area (engine function engine.guilayout_end_area).public static void EndHorizontal()
guilayout.end_horizontal (engine function engine.guilayout_end_horizontal).public static void EndScrollView()
guilayout.end_scroll_view (engine function engine.guilayout_end_scroll_view).public static void EndVertical()
guilayout.end_vertical (engine function engine.guilayout_end_vertical).public static void FlexibleSpace()
guilayout.flexible_space (engine function engine.guilayout_flexible_space).public static double HorizontalSlider(double value, double leftVal, double rightVal)
guilayout.horizontal_slider (engine function engine.guilayout_horizontal_slider).public static void Label(string text)
guilayout.label (engine function engine.guilayout_label).public static string PasswordField(string text, string mask)
guilayout.password_field (engine function engine.guilayout_password_field).public static bool RepeatButton(string text)
guilayout.repeat_button (engine function engine.guilayout_repeat_button).public static void Space(double pixels)
guilayout.space (engine function engine.guilayout_space).public static string TextArea(string text)
guilayout.text_area (engine function engine.guilayout_text_area).public static string TextField(string text)
guilayout.text_field (engine function engine.guilayout_text_field).public static bool Toggle(bool value, string text)
guilayout.toggle (engine function engine.guilayout_toggle).public static double VerticalSlider(double value, double topVal, double bottomVal)
guilayout.vertical_slider (engine function engine.guilayout_vertical_slider).Kaskade
public static class InputApi
public static bool CursorLocked()
input.cursor_locked (engine function engine.cursor_locked).public static bool KeyDown(string key)
input.key_down (engine function engine.key_down).public static bool KeyPressed(string key)
input.key_pressed (engine function engine.key_pressed).public static bool KeyReleased(string key)
input.key_released (engine function engine.key_released).public static EngineValue MouseDelta()
input.mouse_delta (engine function engine.mouse_delta).public static bool MouseDown(int button)
input.mouse_down (engine function engine.mouse_down).public static EngineValue MousePosition()
input.mouse_position (engine function engine.mouse_position).public static bool MousePressed(int button)
input.mouse_pressed (engine function engine.mouse_pressed).public static bool MouseReleased(int button)
input.mouse_released (engine function engine.mouse_released).public static EngineValue RawMouseDelta()
input.raw_mouse_delta (engine function engine.raw_mouse_delta).public static EngineValue ScrollDelta()
input.scroll_delta (engine function engine.mouse_scroll_delta).public static void SetCursorLocked(bool locked)
input.set_cursor_locked (engine function engine.set_cursor_locked).Kaskade
public static class MaterialApi
public static void Set(GameObject? entity, string name, EngineValue value)
material.set (engine function engine.material_set).public static void SetInt(GameObject? entity, string name, int value)
material.set_int (engine function engine.material_set_int).public static void SetKeyword(GameObject? entity, string keyword, bool enabled)
material.set_keyword (engine function engine.material_set_keyword).public static void SetShader(GameObject? entity, string path)
material.set_shader (engine function engine.material_set_shader).Kaskade
public static class PhysicsApi
public static double AngularDamping(GameObject? entity)
physics.angular_damping (engine function engine.physics_angular_damping).public static Vector3 AngularVelocity(GameObject? entity)
physics.angular_velocity (engine function engine.physics_angular_velocity).public static void ApplyForce(GameObject? entity, Vector3 forceVec3)
physics.apply_force (engine function engine.physics_apply_force).public static void ApplyForceAtPosition(GameObject? entity, Vector3 forceVec3, Vector3 worldPosVec3)
physics.apply_force_at_position (engine function engine.physics_apply_force_at_position).public static void ApplyImpulse(GameObject? entity, Vector3 impulseVec3)
physics.apply_impulse (engine function engine.physics_apply_impulse).public static void ApplyImpulseAtPosition(GameObject? entity, Vector3 impulseVec3, Vector3 worldPosVec3)
physics.apply_impulse_at_position (engine function engine.physics_apply_impulse_at_position).public static void ApplyTorque(GameObject? entity, Vector3 torqueVec3)
physics.apply_torque (engine function engine.physics_apply_torque).public static void ApplyTorqueImpulse(GameObject? entity, Vector3 torqueVec3)
physics.apply_torque_impulse (engine function engine.physics_apply_torque_impulse).public static double GravityScale(GameObject? entity)
physics.gravity_scale (engine function engine.physics_gravity_scale).public static bool IsAwake(GameObject? entity)
physics.is_awake (engine function engine.physics_is_awake).public static double LinearDamping(GameObject? entity)
physics.linear_damping (engine function engine.physics_linear_damping).public static Vector3 LinearVelocity(GameObject? entity)
physics.linear_velocity (engine function engine.physics_linear_velocity).public static double Mass(GameObject? entity)
physics.mass (engine function engine.physics_mass).public static EngineValue Raycast(Vector3 originVec3, Vector3 directionVec3, double maxDist)
physics.raycast (engine function engine.physics_raycast).public static void SetAngularDamping(GameObject? entity, double damping)
physics.set_angular_damping (engine function engine.physics_set_angular_damping).public static void SetAngularVelocity(GameObject? entity, Vector3 angularVelocityVec3)
physics.set_angular_velocity (engine function engine.physics_set_angular_velocity).public static void SetAwake(GameObject? entity, bool awake)
physics.set_awake (engine function engine.physics_set_awake).public static void SetEnabled(GameObject? entity, bool enabled)
physics.set_enabled (engine function engine.physics_set_enabled).public static void SetGravityScale(GameObject? entity, double scale)
physics.set_gravity_scale (engine function engine.physics_set_gravity_scale).public static void SetKinematic(GameObject? entity, bool kinematic)
physics.set_kinematic (engine function engine.physics_set_kinematic).public static void SetLinearDamping(GameObject? entity, double damping)
physics.set_linear_damping (engine function engine.physics_set_linear_damping).public static void SetLinearVelocity(GameObject? entity, Vector3 velocityVec3)
physics.set_linear_velocity (engine function engine.physics_set_linear_velocity).public static void SetMass(GameObject? entity, double mass)
physics.set_mass (engine function engine.physics_set_mass).public static void SetTargetTransform(GameObject? entity, Vector3 posVec3, Quaternion rotQuat, double timeStep)
physics.set_target_transform (engine function engine.physics_set_target_transform).public static void SetTransform(GameObject? entity, Vector3 posVec3, Quaternion rotQuat)
physics.set_transform (engine function engine.physics_set_transform).Kaskade
public static class PrefsApi
public static void Delete(string key)
prefs.delete (engine function engine.prefs_delete).public static void DeleteAll()
prefs.delete_all (engine function engine.prefs_delete_all).public static string GetString(string key, string fallback)
prefs.get_string (engine function engine.prefs_get_string).public static bool Has(string key)
prefs.has (engine function engine.prefs_has).public static bool Save()
prefs.save (engine function engine.prefs_save).public static void SetFloat(string key, double value)
prefs.set_float (engine function engine.prefs_set_float).public static void SetInt(string key, int value)
prefs.set_int (engine function engine.prefs_set_int).public static void SetString(string key, string value)
prefs.set_string (engine function engine.prefs_set_string).Kaskade
public static class RenderTextureApi
public static void Create(string name, int width, int height, string format, bool randomWrite)
render_texture.create (engine function engine.render_texture_create).public static void Release(string name)
render_texture.release (engine function engine.render_texture_release).Kaskade
public static class SceneApi
public static string ActiveSceneName()
scene.active_scene_name (engine function engine.active_scene_name).public static bool Alive(Scene sceneHandle)
scene.alive (engine function engine.scene_alive).public static GameObject? FindObject(Scene sceneHandle, string objectName)
scene.find_object (engine function engine.find_object).public static void KeepAlive(GameObject? entity)
scene.keep_alive (engine function engine.scene_keep_alive).public static void Load(string scenePath)
scene.load (engine function engine.scene_load).public static EngineValue LoadAdditive(string scenePath)
scene.load_additive (engine function engine.scene_load_additive).public static string Name(Scene sceneHandle)
scene.name (engine function engine.scene_name).public static GameObject? ObjectAt(Scene sceneHandle, int index)
scene.object_at (engine function engine.scene_object_at).public static int ObjectCount(Scene sceneHandle)
scene.object_count (engine function engine.scene_object_count).public static GameObject? RootAt(Scene sceneHandle, int index)
scene.root_at (engine function engine.scene_root_at).public static int RootCount(Scene sceneHandle)
scene.root_count (engine function engine.scene_root_count).public static void Unload(Scene sceneHandle)
scene.unload (engine function engine.scene_unload).Kaskade
public static class SettingsApi
public static EngineValue Resolutions()
settings.resolutions (engine function engine.settings_resolutions).public static bool Save()
settings.save (engine function engine.settings_save).public static void Set(string key, EngineValue value)
settings.set (engine function engine.settings_set).Kaskade
public static class ShaderApi
public static void SetGlobal(string name, EngineValue value)
shader.set_global (engine function engine.shader_set_global).Kaskade
public static class SpatialApi
public static bool CastRay(Vector3 originVec3, Vector3 directionVec3, double maxDist, int layerMask)
spatial.cast_ray (engine function engine.spatial_cast_ray).public static EngineValue CastRayDetailed(EngineValue rayObj, double maxDist, int layerMask)
spatial.cast_ray_detailed (engine function engine.spatial_cast_ray_detailed).public static bool CheckBox(Vector3 centerVec3, Vector3 halfExtentsVec3, Quaternion rotationQuat, int layerMask)
spatial.check_box (engine function engine.spatial_check_box).public static bool CheckSphere(Vector3 centerVec3, double radius, int layerMask)
spatial.check_sphere (engine function engine.spatial_check_sphere).public static EngineValue ClosestPointOnCollider(GameObject? entity, Vector3 targetPointVec3)
spatial.closest_point_on_collider (engine function engine.spatial_closest_point_on_collider).public static EngineValue GatherInBox(Vector3 centerVec3, Vector3 halfExtentsVec3, Quaternion rotationQuat, int layerMask)
spatial.gather_in_box (engine function engine.spatial_gather_in_box).public static EngineValue GatherInSphere(Vector3 centerVec3, double radius, int layerMask)
spatial.gather_in_sphere (engine function engine.spatial_gather_in_sphere).public static bool LineOfSight(GameObject? sourceEntity, GameObject? targetEntity, int obstructionMask)
spatial.line_of_sight (engine function engine.spatial_line_of_sight).public static EngineValue RaycastAll(Vector3 originVec3, Vector3 directionVec3, double maxDist, int layerMask)
spatial.raycast_all (engine function engine.spatial_raycast_all).public static EngineValue SweepBox(Vector3 centerVec3, Vector3 halfExtentsVec3, Quaternion rotationQuat, Vector3 directionVec3, double maxDist, int layerMask)
spatial.sweep_box (engine function engine.spatial_sweep_box).public static EngineValue SweepCapsule(Vector3 centerVec3, double radius, double halfHeight, Quaternion rotationQuat, Vector3 directionVec3, double maxDist, int layerMask)
spatial.sweep_capsule (engine function engine.spatial_sweep_capsule).public static EngineValue SweepSphere(Vector3 centerVec3, double radius, Vector3 directionVec3, double maxDist, int layerMask)
spatial.sweep_sphere (engine function engine.spatial_sweep_sphere).Kaskade
public static class TimeApi
public static EngineValue CreateTimer(double durationSeconds)
time.create_timer (engine function engine.create_timer).public static double DeltaTime()
time.delta_time (engine function engine.delta_time).public static double Elapsed()
time.elapsed (engine function engine.elapsed_time).public static double FixedDeltaTime()
time.fixed_delta_time (engine function engine.fixed_delta_time).public static EngineValue FrameCount()
time.frame_count (engine function engine.frame_count).public static void SetTimeScale(double scale)
time.set_time_scale (engine function engine.set_time_scale).public static double TimeScale()
time.time_scale (engine function engine.time_scale).public static double UnscaledDeltaTime()
time.unscaled_delta_time (engine function engine.unscaled_delta_time).Kaskade
public static class TransformApi
public static Vector3 EulerAngles(GameObject? entity)
transform.euler_angles (engine function engine.world_rotation_euler).public static Vector3 Forward(GameObject? entity)
transform.forward (engine function engine.forward).public static Vector3 LocalEulerAngles(GameObject? entity)
transform.local_euler_angles (engine function engine.local_rotation_euler).public static Vector3 LocalPosition(GameObject? entity)
transform.local_position (engine function engine.local_position).public static Quaternion LocalRotation(GameObject? entity)
transform.local_rotation (engine function engine.local_rotation_quaternion).public static Vector3 LocalScale(GameObject? entity)
transform.local_scale (engine function engine.local_scale).public static Vector3 Position(GameObject? entity)
transform.position (engine function engine.world_position).public static Vector3 Right(GameObject? entity)
transform.right (engine function engine.right).public static Quaternion Rotation(GameObject? entity)
transform.rotation (engine function engine.world_rotation_quaternion).public static Vector3 Scale(GameObject? entity)
transform.scale (engine function engine.world_scale).public static GameObject? Self()
transform.self (engine function engine.self_entity).public static Vector3 Up(GameObject? entity)
transform.up (engine function engine.up).Kaskade
public static class UiApi
public static void Alpha(double a)
ui.alpha (engine function engine.ui_push_alpha).public static bool Button(string id, double x, double y, double w, double h, string label)
ui.button (engine function engine.ui_button).public static void Capture(bool captured)
ui.capture (engine function engine.ui_capture).public static bool Captured()
ui.captured (engine function engine.ui_captured).public static bool Clicked(double x, double y, double w, double h)
ui.clicked (engine function engine.ui_clicked).public static void Clip(double x, double y, double w, double h)
ui.clip (engine function engine.ui_push_clip).public static double Ease(EngineValue ease, double t)
ui.ease (engine function engine.ui_ease).public static bool ElementClicked(string name)
ui.element_clicked (engine function engine.ui_element_clicked).public static int Font(string path)
ui.font (engine function engine.ui_font).public static bool Held(double x, double y, double w, double h)
ui.held (engine function engine.ui_held).public static bool Hovered(double x, double y, double w, double h)
ui.hovered (engine function engine.ui_hovered).public static EngineValue ImageSize(string path)
ui.image_size (engine function engine.ui_image_size).public static bool KeyDown(string key)
ui.key_down (engine function engine.ui_key_down).public static bool KeyPressed(string key)
ui.key_pressed (engine function engine.ui_key_pressed).public static EngineValue MeasureEx(double size, string s, int font, double wrap)
ui.measure_ex (engine function engine.ui_measure).public static EngineValue Mix(EngineValue a, EngineValue b, double t)
ui.mix (engine function engine.ui_mix).public static void Progress(double x, double y, double w, double h, double t)
ui.progress (engine function engine.ui_progress).public static EngineValue Rgba(double r, double g, double b, double a)
ui.rgba (engine function engine.ui_color).public static double Slider(string id, double x, double y, double w, double value, double min, double max)
ui.slider (engine function engine.ui_slider).public static void Snap(string id, double value)
ui.snap (engine function engine.ui_snap).public static double Spring(string id, double target, double stiffness, double damping)
ui.spring (engine function engine.ui_spring).public static EngineValue Stats()
ui.stats (engine function engine.ui_stats).public static void Theme(EngineValue button, EngineValue hover, EngineValue border, EngineValue accent, EngineValue text, EngineValue shadow, double radius, double textSize)
ui.theme (engine function engine.ui_set_theme).public static double Time()
ui.time (engine function engine.ui_time).public static bool Toggle(string id, double x, double y, bool value)
ui.toggle (engine function engine.ui_toggle).public static double Tween(string id, double target, double duration, EngineValue ease)
ui.tween (engine function engine.ui_tween).public static double TweenFrom(string id, double initial, double target, double duration, EngineValue ease)
ui.tween_from (engine function engine.ui_tween_from).public static void Unalpha()
ui.unalpha (engine function engine.ui_pop_alpha).public static void Unclip()
ui.unclip (engine function engine.ui_pop_clip).UnityEngine.InputSystem.Controls
public class ButtonControl
Input.public static string? Simulated
ButtonControl.SimulatedFrame.public static long SimulatedFrame
ButtonControl.Simulated is pressed on.public bool isPressed { get; }
public bool wasPressedThisFrame { get; }
public bool wasReleasedThisFrame { get; }
public float ReadValue()
UnityEngine
public struct Color
Color: same as Color, converting to and from it implicitly.public Color()
public Color(float r, float g, float b, float a = 1)
public float a
public float b
public float g
public float r
public static Color black { get; }
public static Color blue { get; }
public static Color clear { get; }
public static Color cyan { get; }
public static Color gray { get; }
public static Color green { get; }
public static Color grey { get; }
public static Color magenta { get; }
public static Color red { get; }
public static Color white { get; }
public static Color yellow { get; }
public override bool Equals(object? obj)
bool ValueType.Equals(object? obj).public override int GetHashCode()
int ValueType.GetHashCode().public override string ToString()
string? ValueType.ToString().public static Color operator +(Color a, Color b)
public static bool operator ==(Color lhs, Color rhs)
public static implicit operator Color(Color c)
public static implicit operator Color(Color c)
public static bool operator !=(Color lhs, Color rhs)
public static Color operator *(Color a, float b)
public static Color operator *(Color a, Color b)
public static Color operator -(Color a, Color b)
UnityEngine
public static class GUI
GUI: same as GUI, converting to and from it implicitly.public static Color backgroundColor { get; set; }
public static Color color { get; set; }
public static Color contentColor { get; set; }
public static bool enabled { get; set; }
public static void Box(Rect position, string text)
public static bool Button(Rect position, string text)
public static float HorizontalScrollbar(Rect position, float value, float size, float leftValue, float rightValue)
public static float HorizontalSlider(Rect position, float value, float leftValue, float rightValue)
public static void Label(Rect position, string text)
public static string PasswordField(Rect position, string password, char mask = '*', int maxLength = 256)
public static bool RepeatButton(Rect position, string text)
public static string TextArea(Rect position, string text, int maxLength = 1024)
public static string TextField(Rect position, string text, int maxLength = 256)
public static bool Toggle(Rect position, bool value, string text)
public static float VerticalScrollbar(Rect position, float value, float size, float topValue, float bottomValue)
public static float VerticalSlider(Rect position, float value, float topValue, float bottomValue)
UnityEngine
public static class GUILayout
GUILayout: same as GUILayout, converting to and from it implicitly.public static void BeginArea(Rect screenRect)
public static void BeginHorizontal()
public static Vector2 BeginScrollView(Vector2 scrollPosition, float width = 0, float height = 0)
public static void BeginVertical()
public static void Box(string text)
public static bool Button(string text)
public static void EndArea()
public static void EndHorizontal()
public static void EndScrollView()
public static void EndVertical()
public static void FlexibleSpace()
public static float HorizontalSlider(float value, float leftValue, float rightValue)
public static void Label(string text)
public static string PasswordField(string password, char mask = '*', int maxLength = 256)
public static bool RepeatButton(string text)
public static void Space(float pixels)
public static string TextArea(string text, int maxLength = 1024)
public static string TextField(string text, int maxLength = 256)
public static bool Toggle(bool value, string text)
public static float VerticalSlider(float value, float topValue, float bottomValue)
UnityEngine.InputSystem.Controls
public sealed class KeyControl
Inherits ButtonControl
UnityEngine.InputSystem
public sealed class Keyboard
public Keyboard()
public KeyControl aKey { get; }
public KeyControl bKey { get; }
public KeyControl backspaceKey { get; }
public KeyControl cKey { get; }
public static Keyboard current { get; }
public KeyControl dKey { get; }
public KeyControl eKey { get; }
public KeyControl enterKey { get; }
public KeyControl escapeKey { get; }
public KeyControl f8Key { get; }
public KeyControl f9Key { get; }
public KeyControl fKey { get; }
public KeyControl gKey { get; }
public KeyControl leftCtrlKey { get; }
public KeyControl leftShiftKey { get; }
public KeyControl numpadEnterKey { get; }
public KeyControl qKey { get; }
public KeyControl rKey { get; }
public KeyControl sKey { get; }
public KeyControl spaceKey { get; }
public KeyControl tabKey { get; }
public KeyControl wKey { get; }
UnityEngine.InputSystem
public sealed class Mouse
public Mouse()
public static Mouse current { get; }
public Vector2Control delta { get; }
public ButtonControl leftButton { get; }
public ButtonControl middleButton { get; }
public Vector2Control position { get; }
public ButtonControl rightButton { get; }
public Vector2Control scroll { get; }
UnityEngine
public struct Rect
Rect: same as Rect, converting to and from it implicitly.public Rect()
public Rect(float x, float y, float width, float height)
public Rect(Vector2 position, Vector2 size)
public float height
public float width
public float x
public float y
public Vector2 center { get; set; }
public Vector2 max { get; set; }
public Vector2 min { get; set; }
public Vector2 position { get; set; }
public Vector2 size { get; set; }
public float xMax { get; set; }
public float xMin { get; set; }
public float yMax { get; set; }
public float yMin { get; set; }
public static Rect zero { get; }
public bool Contains(Vector2 point)
public override bool Equals(object? obj)
bool ValueType.Equals(object? obj).public override int GetHashCode()
int ValueType.GetHashCode().public bool Overlaps(Rect other)
public override string ToString()
string? ValueType.ToString().public static bool operator ==(Rect lhs, Rect rhs)
public static implicit operator Rect(Rect r)
public static implicit operator Rect(Rect r)
public static bool operator !=(Rect lhs, Rect rhs)
UnityEngine
public struct Vector2
Vector2: same as Vector2, converting to and from it implicitly.public Vector2()
public Vector2(float x, float y)
public float x
public float y
public static Vector2 down { get; }
public static Vector2 left { get; }
public static Vector2 one { get; }
public static Vector2 right { get; }
public static Vector2 up { get; }
public static Vector2 zero { get; }
public override bool Equals(object? obj)
bool ValueType.Equals(object? obj).public override int GetHashCode()
int ValueType.GetHashCode().public override string ToString()
string? ValueType.ToString().public static Vector2 operator +(Vector2 a, Vector2 b)
public static Vector2 operator /(Vector2 a, float d)
public static bool operator ==(Vector2 a, Vector2 b)
public static implicit operator Vector2(Vector2 v)
public static implicit operator Vector2(Vector2 v)
public static bool operator !=(Vector2 a, Vector2 b)
public static Vector2 operator *(Vector2 a, float d)
public static Vector2 operator -(Vector2 a, Vector2 b)
UnityEngine.InputSystem.Controls
public sealed class Vector2Control
public Vector2 ReadValue()
Kaskade.Interop
public struct AbiValue
public AbiValue()
public ulong* Data
public uint Flags
public AbiValueTag Tag
public double Data0 { get; set; }
Kaskade.Interop
public enum AbiValueTag : uint
AbiValue. Interop detail used by generated code.Array = 13
Bool = 1
Component = 8
Entity = 7
F32 = 4
F64 = 5
I32 = 2
I64 = 3
Null = 0
Quaternion = 12
Scene = 9
Utf8 = 6
Vec2 = 10
Vec3 = 11
Kaskade
public enum BehaviourLifecycleMask : uint
Destroy = 64
Behaviour.OnDestroy is overridden.Disable = 32
Behaviour.OnDisable is overridden.Enable = 4
Behaviour.OnEnable is overridden.LateUpdate = 16
Behaviour.LateUpdate is overridden.None = 0
Ready = 2
Behaviour.OnReady is overridden.Reset = 1
Behaviour.OnReset is overridden.Update = 8
Behaviour.Update is overridden.Kaskade
public readonly readonly struct BehaviourMetadata
Implements IEquatable<BehaviourMetadata>
public BehaviourMetadata()
public BehaviourMetadata(ulong TypeIdLow, ulong TypeIdHigh, string TypeName, BehaviourLifecycleMask LifecycleMask)
public BehaviourLifecycleMask LifecycleMask { get; init; }
public ulong TypeIdHigh { get; init; }
public ulong TypeIdLow { get; init; }
public string TypeName { get; init; }
public void Deconstruct(out ulong TypeIdLow, out ulong TypeIdHigh, out string TypeName, out BehaviourLifecycleMask LifecycleMask)
public bool Equals(BehaviourMetadata other)
public override bool Equals(object obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(BehaviourMetadata left, BehaviourMetadata right)
public static bool operator !=(BehaviourMetadata left, BehaviourMetadata right)
Kaskade
public readonly readonly struct EngineValue
[x, y, z], objects are handles).
public EngineValue()
public EngineValue[] AsArray { get; }
public bool AsBool { get; }
public Color AsColor { get; }
[r, g, b, a] array as a colour.public double AsDouble { get; }
public float AsFloat { get; }
public GameObject? AsGameObject { get; }
public int AsInt { get; }
public long AsLong { get; }
public Quaternion AsQuaternion { get; }
[x, y, z, w] array as a rotation.public Scene AsScene { get; }
public string AsString { get; }
public Vector2 AsVector2 { get; }
[x, y] array as a vector.public Vector3 AsVector3 { get; }
[x, y, z] array as a vector.public int Count { get; }
public bool IsNull { get; }
public EngineValueKind Kind { get; }
public static EngineValue Null { get; }
public EngineValue this[int index] { get; }
public override string ToString()
string? ValueType.ToString().public static implicit operator EngineValue(Color value)
[r, g, b, a].public static implicit operator EngineValue(EngineValue[] items)
public static implicit operator EngineValue(GameObject? value)
public static implicit operator EngineValue(Quaternion value)
[x, y, z, w].public static implicit operator EngineValue(Scene value)
public static implicit operator EngineValue(Vector2 value)
[x, y].public static implicit operator EngineValue(Vector3 value)
[x, y, z].public static implicit operator EngineValue(bool value)
public static implicit operator EngineValue(double value)
public static implicit operator EngineValue(int value)
public static implicit operator EngineValue(long value)
public static implicit operator EngineValue(float value)
public static implicit operator EngineValue(string? value)
Kaskade
public enum EngineValueKind : byte
EngineValue.Array = 5
Bool = 1
Float = 3
Int = 2
Null = 0
String = 4
Kaskade
public static class FieldCodec
{"index": i, "generation": g},
enums their member name.
public static bool TryRead<T>(JsonNode? node, out T value)
T.public static JsonNode? Write<T>(T value)
Kaskade
public sealed record FieldMetadata
Implements IEquatable<FieldMetadata>
public FieldMetadata(string Name, string Kind, string? Element = null, double? Min = null, double? Max = null, string? Tooltip = null, string? Header = null, string? Asset = null, IReadOnlyList<string>? Options = null, double? Space = null)
public string? Asset { get; init; }
AssetAttribute.public string? Element { get; init; }
public string? Header { get; init; }
HeaderAttribute.public string Kind { get; init; }
public double? Max { get; init; }
RangeAttribute.public double? Min { get; init; }
RangeAttribute.public string Name { get; init; }
public IReadOnlyList<string>? Options { get; init; }
public double? Space { get; init; }
SpaceAttribute, in pixels.public string? Tooltip { get; init; }
TooltipAttribute.public void Deconstruct(out string Name, out string Kind, out string? Element, out double? Min, out double? Max, out string? Tooltip, out string? Header, out string? Asset, out IReadOnlyList<string>? Options, out double? Space)
public bool Equals(FieldMetadata? other)
public override bool Equals(object? obj)
public override int GetHashCode()
public override string ToString()
public static bool operator ==(FieldMetadata? left, FieldMetadata? right)
public static bool operator !=(FieldMetadata? left, FieldMetadata? right)
Kaskade.Interop
public sealed class KaskadeException
Inherits Exception
public int ErrorCode { get; }
Kaskade
public static class ZitoInterop
public static AbiValue DoubleValue(double value)
public static T GetComponent<T>(GameObject owner) where T : struct, IZitoComponent<T>
public static double GetDouble(ComponentHandle component, ulong fieldId)
public static double InvokeDouble(ComponentHandle component, ulong methodId, ReadOnlySpan<AbiValue> arguments)
System.Double.public static void InvokeVoid(ComponentHandle component, ulong methodId, ReadOnlySpan<AbiValue> arguments)
public static void SetDouble(ComponentHandle component, ulong fieldId, double value)