API Reference
Every group and type a NexusScript can call, with signatures. This page is auto-generated from the engine bindings — if a binding exists, it's listed here, so the reference never falls behind. Each section below links to its full guide with explanation and examples; the complete set lives under NexusScript in the sidebar — Transforms · Math · Physics · UI · Animation · Audio · Input & time · Collections · Rendering · Player · NPC · Storage · HTTP.
How to read this
Group.Method(args) -> return is called as written (e.g. Physics.Raycast(...), Mathf.Clamp(...)). Instance types (Transform, Rigidbody, Collider, …) are reached through a handle you already hold — transform, gameObject, hit.collider, GetComponent<Rigidbody>(). A † marks members exposed to visual scripting that may not be callable from a text script.
Lifecycle & callbacks
Methods you implement on your NexusBehaviour (the engine calls them) — not in the tables below, which list methods you call. → Basics & lifecycle
| Method |
When |
Start · Update · FixedUpdate · LateUpdate · Awake · OnEnable/OnDisable · OnDestroy |
engine lifecycle (protected override) |
OnTriggerEnter/Stay/Exit(Collider) · OnCollisionEnter/Stay/Exit(Collision) |
physics (by name) |
OnPlayerJoined(id) · OnPlayerLeft(id) |
player presence (by name) |
Players, NPCs & AI
Guide: Players, NPCs & AI — explanation, examples, and gotchas.
Player
| Member |
Signature |
AddVelocity |
(playerId: int, velocity: Vector3) |
DisableFlying |
(playerId: int) |
EnableFlying |
(playerId: int) |
GetAvatarEyeHeight |
|
GetAvatarHeight |
|
GetAvatarId |
|
GetAvatarRoot |
|
GetBonePosition |
|
GetBoneRotation |
|
GetDisplayName |
(playerId: int) -> string |
GetDistance |
|
GetDistanceTo |
|
GetDistanceToPlayer |
|
GetHeadPosition |
|
GetHeadRotation |
|
GetName |
|
GetNearby |
|
GetPlayerCount † |
() -> int |
GetPlayerId |
|
GetPosition |
(playerId: int) -> Vector3 |
GetRotation |
(playerId: int) -> Quaternion |
GetSpeakerId |
|
GetSpeakerUserId |
|
GetUserId |
|
GetUsername |
|
GetVelocity |
(playerId: int) -> Vector3 |
IdOf |
|
Immobilize |
|
IsBehind |
|
IsGrounded |
(playerId: int) -> bool |
IsInFrontOf |
|
IsInRange |
|
IsLocal |
|
IsPlayerInRange |
|
IsValid |
|
IsVisible |
|
Respawn |
(playerId: int) |
RestoreMobility |
|
SetGravity † |
(playerId: int, gravity: float) |
SetGravityStrength |
|
SetJumpHeight |
|
SetJumpImpulse |
|
SetJumpPower † |
(playerId: int, power: float) |
SetRunSpeed |
(playerId: int, speed: float) |
SetVelocity |
(playerId: int, velocity: Vector3) |
SetWalkSpeed |
(playerId: int, speed: float) |
Teleport |
(playerId: int, position: Vector3, rotation: Quaternion) |
NPC
| Member |
Signature |
CommandError |
|
CommandResult |
|
GetState |
|
Notify |
|
NotifyTo |
|
RegisterFunction |
|
Say |
|
SayAs |
|
SayTo |
|
SetState |
|
Think |
|
Self
| Member |
Signature |
AddKnowledge |
|
AddPlayerNote |
|
GetId |
|
GetName |
|
GetPersonality |
|
GetPlayerAffinity |
|
RecordEvent |
|
SetPlayerAffinity |
|
AI
| Member |
Signature |
Chat |
|
ChatWithSystem |
|
GenerateImage |
|
Networking
| Member |
Signature |
GetPlayer |
|
GetPlayerById |
|
GetPlayerCount |
() -> int |
GetPlayers |
|
get_LocalPlayer |
|
Network
| Member |
Signature |
GetOwner |
(obj: GameObject) -> int |
GetSenderId |
() -> int |
IsClient |
|
IsHost |
|
IsOwner |
(obj: GameObject) -> bool |
IsServer |
|
LocalPlayerId |
|
RequestOwnership |
(obj: GameObject) |
SendClientRpc |
(methodName: string, arg0: object) |
SendClientRpcToPlayer † |
(playerId: int, methodName: string, arg0: object) |
SendClientRpcToTarget |
|
SendServerRpc |
(methodName: string, arg0: object) |
SetOwner |
(obj: GameObject, playerId: string) |
TestSerializeRoundtrip |
|
get_IsClient † |
() -> bool |
get_IsHost † |
() -> bool |
get_IsServer † |
() -> bool |
get_LocalPlayerId † |
() -> int |
Voice
| Member |
Signature |
AddListener |
|
AddTalker |
|
ClearTransmitChannel |
|
CreateChannel |
|
DestroyChannel |
|
RemoveMember |
|
ResetVoice |
|
SetTeam |
|
SetTransmitChannel |
|
Scripting & lifecycle
Guide: Scripting & lifecycle — explanation, examples, and gotchas.
NexusBehaviour
| Member |
Signature |
get_enabled |
() -> bool |
get_gameObject |
() -> GameObject |
get_name |
() -> string |
get_tag |
|
get_transform |
() -> Transform |
MonoBehaviour
| Member |
Signature |
StartCoroutine |
|
StopAllCoroutines |
|
StopCoroutine |
|
Object
| Member |
Signature |
Destroy |
(obj: GameObject) |
DontDestroyOnLoad |
|
Instantiate |
(original: GameObject) -> GameObject |
ToString † |
() -> string |
Coroutine
| Member |
Signature |
StartCoroutine † |
(methodName: string) |
StopAllCoroutines † |
() |
StopCoroutine † |
(methodName: string) |
WaitForEndOfFrame † |
() |
WaitForFixedUpdate † |
() |
WaitForSeconds † |
(seconds: float) |
Enumerator
| Member |
Signature |
GetCurrent |
|
MoveNext |
|
WaitForSeconds
WaitForSecondsRealtime
WaitForEndOfFrame
WaitForFixedUpdate
Debug
| Member |
Signature |
DrawLine |
(start: Vector3, end: Vector3, color: Color) |
DrawRay |
(start: Vector3, direction: Vector3, color: Color) |
Log |
(message: object) |
LogError |
(message: object) |
LogWarning |
(message: object) |
GameSignal
| Member |
Signature |
GetBool |
|
GetFloat |
|
GetInt |
|
GetString |
|
Send |
|
SendFloat |
|
SendString |
|
SetFloat |
|
SetInt |
|
SetString |
|
Guide: GameObjects & Transforms — explanation, examples, and gotchas.
GameObject
| Member |
Signature |
BroadcastMessage |
|
CreatePrimitive |
|
Find |
|
FindGameObjectsWithTag |
|
FindWithTag |
|
GetComponent |
(type: string) -> Component |
SendMessage |
(methodName: string) |
SendMessageUpwards |
|
SetActive |
(value: bool) |
activeSelf |
|
get_activeInHierarchy |
|
get_activeSelf |
() -> bool |
get_layer |
() -> int |
get_name |
() -> string |
get_tag |
() -> string |
get_transform |
() -> Transform |
layer |
|
name |
|
set_layer |
|
set_name |
|
set_tag |
|
tag |
|
transform |
|
| Member |
Signature |
GetChild |
|
LookAt |
(worldPosition: Vector3) |
Rotate |
(eulers: Vector3) |
SetParent |
(parent: Transform) |
Translate |
(translation: Vector3) |
childCount |
|
eulerAngles |
|
forward |
|
get_childCount |
|
get_eulerAngles |
() -> Vector3 |
get_forward |
() -> Vector3 |
get_gameObject |
() -> GameObject |
get_localPosition |
() -> Vector3 |
get_localRotation |
() -> Quaternion |
get_localScale |
() -> Vector3 |
get_name |
() -> string |
get_parent |
() -> Transform |
get_position |
() -> Vector3 |
get_right |
() -> Vector3 |
get_rotation |
() -> Quaternion |
get_tag |
() -> string |
get_up |
() -> Vector3 |
localPosition |
|
localRotation |
|
localScale |
|
parent |
|
position |
|
right |
|
rotation |
|
set_eulerAngles |
(value: Vector3) |
set_localPosition |
(value: Vector3) |
set_localRotation |
(value: Quaternion) |
set_localScale |
(value: Vector3) |
set_position |
(value: Vector3) |
set_rotation |
(value: Quaternion) |
up |
|
| Member |
Signature |
get_anchorMax |
() -> Vector2 |
get_anchorMin |
() -> Vector2 |
get_anchoredPosition |
() -> Vector2 |
get_offsetMax |
|
get_offsetMin |
|
get_pivot |
() -> Vector2 |
get_rect |
|
get_sizeDelta |
() -> Vector2 |
set_anchorMax |
(value: Vector2) |
set_anchorMin |
(value: Vector2) |
set_anchoredPosition |
(value: Vector2) |
set_offsetMax |
|
set_offsetMin |
|
set_pivot |
(value: Vector2) |
set_sizeDelta |
(value: Vector2) |
Physics
Guide: Physics — explanation, examples, and gotchas.
Physics
| Member |
Signature |
BoxCast |
(center: Vector3, halfExtents: Vector3, direction: Vector3, maxDistance: float) -> bool |
CapsuleCast |
(point1: Vector3, point2: Vector3, radius: float, direction: Vector3, maxDistance: float) -> bool |
CheckBox † |
(center: Vector3, halfExtents: Vector3) -> bool |
CheckCapsule † |
(start: Vector3, end: Vector3, radius: float) -> bool |
CheckSphere |
(position: Vector3, radius: float) -> bool |
IgnoreCollision |
(collider1: Collider, collider2: Collider) |
Linecast |
(start: Vector3, end: Vector3) -> bool |
OverlapBox |
(center: Vector3, halfExtents: Vector3) -> Collider[] |
OverlapCapsule |
|
OverlapSphere |
(position: Vector3, radius: float) -> Collider[] |
Raycast |
(origin: Vector3, direction: Vector3, maxDistance: float) -> bool |
RaycastAll |
(origin: Vector3, direction: Vector3, maxDistance: float) -> object |
SphereCast |
(origin: Vector3, radius: float, direction: Vector3, maxDistance: float) -> bool |
get_gravity † |
() -> Vector3 |
gravity |
|
Physics2D
| Member |
Signature |
Raycast |
(origin: Vector2, direction: Vector2, distance: float) -> bool |
Rigidbody
| Member |
Signature |
AddForce |
(force: Vector3, forceMode: int) |
AddTorque |
(torque: Vector3, forceMode: int) |
MovePosition |
(position: Vector3) |
MoveRotation |
(rotation: Quaternion) |
angularVelocity |
() -> Vector3 |
get_angularDrag |
|
get_drag |
() -> float |
get_isKinematic |
() -> bool |
get_mass |
() -> float |
get_position |
() -> Vector3 |
get_rotation |
() -> Quaternion |
get_useGravity |
() -> bool |
linearVelocity |
() -> Vector3 |
set_angularDrag |
|
set_drag |
(value: float) |
set_isKinematic |
(value: bool) |
set_mass |
(value: float) |
set_position |
|
set_rotation |
|
set_useGravity |
(value: bool) |
velocity |
|
Rigidbody2D
| Member |
Signature |
AddForce |
(force: Vector2, forceMode: int) |
AddTorque |
(torque: float) |
MovePosition |
(position: Vector2) |
MoveRotation |
(angle: float) |
get_angularVelocity |
() -> float |
get_gravityScale |
() -> float |
get_isKinematic |
() -> bool |
get_mass |
() -> float |
get_velocity |
() -> Vector2 |
set_angularVelocity |
(value: float) |
set_gravityScale |
(value: float) |
set_isKinematic |
(value: bool) |
set_mass |
(value: float) |
set_velocity |
(value: Vector2) |
CharacterController
| Member |
Signature |
Move |
|
SimpleMove |
|
get_center |
|
get_collisionFlags |
|
get_detectCollisions |
|
get_gameObject |
|
get_height |
|
get_isGrounded |
|
get_minMoveDistance |
|
get_radius |
|
get_skinWidth |
|
get_slopeLimit |
|
get_stepOffset |
|
get_transform |
|
get_velocity |
|
set_center |
|
set_detectCollisions |
|
set_height |
|
set_minMoveDistance |
|
set_radius |
|
set_skinWidth |
|
set_slopeLimit |
|
set_stepOffset |
|
Collider
| Member |
Signature |
CompareTag † |
(tag: string) -> bool |
get_attachedRigidbody |
() -> Rigidbody |
get_bounds |
() -> object |
get_gameObject |
() -> GameObject |
get_isTrigger |
() -> bool |
get_tag † |
() -> string |
get_transform |
() -> Transform |
set_isTrigger |
|
BoxCollider
| Member |
Signature |
get_center |
|
get_size |
|
set_center |
|
set_size |
|
SphereCollider
| Member |
Signature |
get_center |
|
get_radius |
|
set_center |
|
set_radius |
|
CapsuleCollider
| Member |
Signature |
get_center |
|
get_height |
|
get_radius |
|
set_center |
|
set_height |
|
set_radius |
|
Collider2D
| Member |
Signature |
get_enabled |
() -> bool |
get_isTrigger |
() -> bool |
set_enabled |
(value: bool) |
set_isTrigger |
(value: bool) |
Collision
| Member |
Signature |
GetContact |
|
get_collider |
() -> Collider |
get_contactCount |
() -> int |
get_gameObject |
() -> GameObject |
get_impulse |
|
get_relativeVelocity |
() -> Vector3 |
get_rigidbody |
() -> Rigidbody |
get_transform |
() -> Transform |
| Member |
Signature |
get_normal |
|
get_otherCollider |
|
get_point |
|
get_separation |
|
get_thisCollider |
|
RaycastHit
| Member |
Signature |
get_collider |
() -> Collider |
get_distance |
() -> float |
get_normal |
() -> Vector3 |
get_point |
() -> Vector3 |
get_rigidbody |
() -> Rigidbody |
get_transform |
() -> Transform |
Ray
| Member |
Signature |
GetPoint |
|
get_direction |
|
get_origin |
|
LayerMask
| Member |
Signature |
GetMask |
(layerName: string) -> int |
LayerToName |
(layer: int) -> string |
NameToLayer |
(layerName: string) -> int |
Math & geometry
Guide: Math & geometry — explanation, examples, and gotchas.
Vector2
| Member |
Signature |
Angle † |
(from: Vector2, to: Vector2) -> float |
Distance † |
(a: Vector2, b: Vector2) -> float |
Dot † |
(lhs: Vector2, rhs: Vector2) -> float |
Lerp † |
(a: Vector2, b: Vector2, t: float) -> Vector2 |
down |
() -> Vector2 |
get_magnitude |
|
get_normalized |
|
get_sqrMagnitude |
|
get_x |
() -> float |
get_y |
() -> float |
left |
() -> Vector2 |
magnitude |
() -> float |
normalized |
() -> Vector2 |
one |
() -> Vector2 |
op_Add |
|
op_Divide |
|
op_DivideScalar |
|
op_Equality |
|
op_Inequality |
|
op_Multiply |
|
op_MultiplyReverse |
|
op_MultiplyScalar |
|
op_Subtract |
|
right |
() -> Vector2 |
set_x |
|
set_y |
|
sqrMagnitude |
|
up |
() -> Vector2 |
x |
|
y |
|
zero |
() -> Vector2 |
Vector3
| Member |
Signature |
Angle |
(from: Vector3, to: Vector3) -> float |
Cross |
(lhs: Vector3, rhs: Vector3) -> Vector3 |
Distance |
(a: Vector3, b: Vector3) -> float |
Dot |
(lhs: Vector3, rhs: Vector3) -> float |
Lerp |
(a: Vector3, b: Vector3, t: float) -> Vector3 |
Normalize |
(value: Vector3) -> Vector3 |
Project |
(vector: Vector3, onNormal: Vector3) -> Vector3 |
Reflect |
(inDirection: Vector3, inNormal: Vector3) -> Vector3 |
back |
() -> Vector3 |
down |
() -> Vector3 |
forward |
() -> Vector3 |
get_magnitude |
|
get_normalized |
|
get_sqrMagnitude |
|
get_x |
() -> float |
get_y |
() -> float |
get_z |
() -> float |
left |
() -> Vector3 |
magnitude |
() -> float |
normalized |
() -> Vector3 |
one |
() -> Vector3 |
op_Add |
(a: Vector3, b: Vector3) -> Vector3 |
op_Divide |
|
op_Equality |
|
op_Inequality |
|
op_Multiply |
(a: Vector3, d: float) -> Vector3 |
op_MultiplyReverse |
|
op_Subtract |
(a: Vector3, b: Vector3) -> Vector3 |
right |
() -> Vector3 |
set_x |
|
set_y |
|
set_z |
|
sqrMagnitude |
() -> float |
up |
() -> Vector3 |
x |
|
y |
|
z |
|
zero |
() -> Vector3 |
Vector4
| Member |
Signature |
Distance |
|
Dot |
|
Lerp |
|
get_w |
|
get_x |
|
get_y |
|
get_z |
|
magnitude |
|
normalized |
|
one |
|
op_Add |
|
op_Divide |
|
op_Equality |
|
op_Inequality |
|
op_Multiply |
|
op_Subtract |
|
sqrMagnitude |
|
w |
|
x |
|
y |
|
z |
|
zero |
|
Quaternion
| Member |
Signature |
AngleAxis |
(angle: float, axis: Vector3) -> Quaternion |
Euler |
(x: float, y: float, z: float) -> Quaternion |
LookRotation |
(forward: Vector3) -> Quaternion |
Slerp |
(a: Quaternion, b: Quaternion, t: float) -> Quaternion |
eulerAngles |
() -> Vector3 |
get_eulerAngles |
|
get_normalized |
|
get_w |
() -> float |
get_x |
() -> float |
get_y |
() -> float |
get_z |
() -> float |
identity |
() -> Quaternion |
normalized |
|
op_Equality |
|
op_Inequality |
|
op_Multiply |
(a: Quaternion, b: Quaternion) -> Quaternion |
op_MultiplyVector |
|
w |
|
x |
|
y |
|
z |
|
Color
| Member |
Signature |
Lerp |
(a: Color, b: Color, t: float) -> Color |
a |
|
b |
|
black |
() -> Color |
blue |
() -> Color |
clear |
|
cyan |
() -> Color |
g |
|
gamma |
|
get_a |
() -> float |
get_b |
() -> float |
get_g |
() -> float |
get_gamma |
|
get_grayscale |
|
get_linear |
|
get_r |
() -> float |
gray |
|
grayscale |
|
green |
() -> Color |
grey |
|
linear |
|
magenta |
() -> Color |
op_Add |
|
op_Divide |
|
op_DivideScalar |
|
op_Equality |
|
op_Inequality |
|
op_Multiply |
|
op_MultiplyScalar |
|
op_Subtract |
|
r |
|
red |
() -> Color |
white |
() -> Color |
yellow |
() -> Color |
Matrix4x4
| Member |
Signature |
GetColumn |
|
GetRow |
|
MultiplyPoint |
|
MultiplyPoint3x4 |
|
MultiplyVector |
|
Scale |
|
TRS |
|
Translate |
|
determinant |
|
identity |
|
isIdentity |
|
m00 |
|
m01 |
|
m02 |
|
m03 |
|
m10 |
|
m11 |
|
m12 |
|
m13 |
|
m20 |
|
m21 |
|
m22 |
|
m23 |
|
m30 |
|
m31 |
|
m32 |
|
m33 |
|
op_Multiply |
|
op_MultiplyVector |
|
transpose |
|
zero |
|
Mathf
| Member |
Signature |
Abs |
(f: float) -> float |
Acos |
|
Asin |
|
Atan2 |
|
Ceil |
(f: float) -> float |
CeilToInt |
|
Clamp |
(value: float, min: float, max: float) -> float |
Clamp01 |
(value: float) -> float |
Cos |
(f: float) -> float |
Deg2Rad |
() -> float |
Epsilon |
|
FMod |
|
Floor |
(f: float) -> float |
FloorToInt |
|
Infinity |
|
InverseLerp |
|
Lerp |
(a: float, b: float, t: float) -> float |
LerpUnclamped |
|
Log |
|
Log10 |
|
Max |
(a: float, b: float) -> float |
Min |
(a: float, b: float) -> float |
NegativeInfinity |
|
PI |
() -> float |
Pow |
|
Rad2Deg |
() -> float |
Repeat |
|
Round |
(f: float) -> float |
RoundToInt |
|
Sign |
|
Sin |
(f: float) -> float |
Sqrt |
(f: float) -> float |
Tan |
(f: float) -> float |
get_Epsilon |
|
get_Infinity |
|
get_NegativeInfinity |
|
Random
| Member |
Signature |
Range |
|
Range_float † |
(min: float, max: float) -> float |
Range_int † |
(min: int, max: int) -> int |
get_insideUnitCircle |
() -> Vector2 |
get_insideUnitSphere |
() -> Vector3 |
get_onUnitSphere |
() -> Vector3 |
get_rotation |
() -> Quaternion |
get_value |
() -> float |
insideUnitCircle |
|
insideUnitSphere |
|
onUnitSphere |
|
rotation |
|
value |
|
Rect
| Member |
Signature |
Contains |
|
MinMaxRect |
|
Overlaps |
|
center |
|
get_height |
|
get_width |
|
get_x |
|
get_y |
|
height |
|
max |
|
min |
|
position |
|
size |
|
width |
|
x |
|
xMax |
|
xMin |
|
y |
|
yMax |
|
yMin |
|
zero |
|
Bounds
| Member |
Signature |
ClosestPoint |
|
Contains |
|
Intersects |
|
SqrDistance |
|
center |
|
extents |
|
get_center |
|
get_extents |
|
get_max |
|
get_min |
|
get_size |
|
max |
|
min |
|
size |
|
UI
Guide: UI — explanation, examples, and gotchas.
UI
| Member |
Signature |
AddRectMask2D |
|
AttachNexusScript |
|
CreateButton |
|
CreateCanvas |
|
CreateChild |
|
CreateImage |
|
CreateLabel |
|
CreatePanel |
|
CreateText |
|
EnsureEventSystem |
|
FindButton |
|
FindText |
|
GetButton |
|
GetImage |
|
GetText |
|
SetActive |
(uiObject: GameObject, active: bool) |
SetAnchors |
|
SetButtonColors |
|
SetButtonTargetGraphic |
|
SetImageRaycastTarget |
|
SetParent |
|
SetRect |
|
Stretch |
|
| Member |
Signature |
AddClickListener |
(methodName: string) |
RemoveAllListeners |
() |
get_interactable |
() -> bool |
get_onClick |
|
set_interactable |
(value: bool) |
Text
| Member |
Signature |
get_alignment |
|
get_color |
|
get_fontSize |
|
get_text |
() -> string |
set_alignment |
|
set_color |
(value: Color) |
set_fontSize |
(value: int) |
set_text |
(value: string) |
Image
| Member |
Signature |
get_color |
() -> Color |
get_fillAmount † |
() -> float |
set_color |
(value: Color) |
set_fillAmount † |
(value: float) |
Slider
| Member |
Signature |
get_interactable |
|
get_maxValue |
() -> float |
get_minValue |
() -> float |
get_onValueChanged |
|
get_value |
() -> float |
get_wholeNumbers |
|
set_interactable |
|
set_maxValue |
|
set_minValue |
|
set_value |
(value: float) |
set_wholeNumbers |
|
Toggle
| Member |
Signature |
get_interactable |
|
get_isOn |
() -> bool |
get_onValueChanged |
|
set_interactable |
|
set_isOn |
(value: bool) |
Dropdown
| Member |
Signature |
get_interactable |
|
get_onValueChanged |
|
get_value |
() -> int |
set_interactable |
|
set_value |
(value: int) |
| Member |
Signature |
get_characterLimit |
|
get_interactable |
|
get_onEndEdit |
|
get_onValueChanged |
|
get_readOnly |
|
get_text |
() -> string |
set_characterLimit |
|
set_interactable |
|
set_readOnly |
|
set_text |
(value: string) |
| Member |
Signature |
get_horizontal |
() -> bool |
get_horizontalNormalizedPosition |
() -> float |
get_onValueChanged |
|
get_vertical |
() -> bool |
get_verticalNormalizedPosition |
() -> float |
set_horizontal |
(value: bool) |
set_horizontalNormalizedPosition |
(value: float) |
set_vertical |
(value: bool) |
set_verticalNormalizedPosition |
(value: float) |
| Member |
Signature |
get_interactable |
|
get_numberOfSteps |
|
get_onValueChanged |
|
get_size |
|
get_value |
|
set_interactable |
|
set_numberOfSteps |
|
set_size |
|
set_value |
|
CanvasGroup
| Member |
Signature |
get_alpha |
() -> float |
get_blocksRaycasts |
|
get_ignoreParentGroups |
|
get_interactable |
() -> bool |
set_alpha |
(value: float) |
set_blocksRaycasts |
|
set_ignoreParentGroups |
|
set_interactable |
(value: bool) |
HorizontalLayoutGroup
| Member |
Signature |
get_childControlHeight |
() -> bool |
get_childControlWidth |
() -> bool |
get_childForceExpandHeight |
() -> bool |
get_childForceExpandWidth |
() -> bool |
get_spacing |
() -> float |
set_childControlHeight |
(value: bool) |
set_childControlWidth |
(value: bool) |
set_childForceExpandHeight |
(value: bool) |
set_childForceExpandWidth |
(value: bool) |
set_spacing |
(value: float) |
VerticalLayoutGroup
| Member |
Signature |
get_childControlHeight |
() -> bool |
get_childControlWidth |
() -> bool |
get_childForceExpandHeight |
() -> bool |
get_childForceExpandWidth |
() -> bool |
get_spacing |
() -> float |
set_childControlHeight |
(value: bool) |
set_childControlWidth |
(value: bool) |
set_childForceExpandHeight |
(value: bool) |
set_childForceExpandWidth |
(value: bool) |
set_spacing |
(value: float) |
LayoutElement
| Member |
Signature |
get_flexibleHeight |
|
get_flexibleWidth |
|
get_ignoreLayout |
|
get_minHeight |
|
get_minWidth |
|
get_preferredHeight |
|
get_preferredWidth |
|
set_flexibleHeight |
|
set_flexibleWidth |
|
set_ignoreLayout |
|
set_minHeight |
|
set_minWidth |
|
set_preferredHeight |
|
set_preferredWidth |
|
ContentSizeFitter
| Member |
Signature |
get_horizontalFit |
|
get_verticalFit |
|
set_horizontalFit |
|
set_verticalFit |
|
| Member |
Signature |
AddListener |
|
Invoke |
|
RemoveAllListeners |
|
RemoveListener |
|
SliderEvent
| Member |
Signature |
AddListener |
|
ToggleEvent
| Member |
Signature |
AddListener |
|
DropdownEvent
| Member |
Signature |
AddListener |
|
| Member |
Signature |
AddListener |
|
| Member |
Signature |
AddListener |
|
| Member |
Signature |
AddListener |
|
Animation & navigation
Guide: Animation & navigation — explanation, examples, and gotchas.
Animator
| Member |
Signature |
ApplyBuiltinRootMotion |
|
CrossFade |
(stateName: string, duration: float) |
CrossFadeInFixedTime |
(stateName: string, duration: float) |
GetBoneTransform |
(bone: string) -> Transform |
GetBool |
(name: string) -> bool |
GetCurrentAnimatorStateInfo |
|
GetFloat |
(name: string) -> float |
GetIKPosition |
(goal: string) -> Vector3 |
GetIKRotation |
(goal: string) -> Quaternion |
GetInteger |
(name: string) -> int |
GetLayerIndex |
|
GetLayerName |
(layerIndex: int) -> string |
GetLayerWeight |
(layerIndex: int) -> float |
GetNextAnimatorStateInfo |
|
InterruptMatchTarget |
|
IsInTransition |
(layerIndex: int) -> bool |
MatchTarget |
|
Play |
(stateName: string) |
PlayInFixedTime |
(stateName: string) |
ResetTrigger |
(name: string) |
SetBool |
(name: string, value: bool) |
SetFloat |
(name: string, value: float) |
SetIKHintPosition |
(hint: string, position: Vector3) |
SetIKHintPositionWeight |
(hint: string, weight: float) |
SetIKPosition |
(goal: string, position: Vector3) |
SetIKPositionWeight |
(goal: string, weight: float) |
SetIKRotation |
(goal: string, rotation: Quaternion) |
SetIKRotationWeight |
(goal: string, weight: float) |
SetInteger |
(name: string, value: int) |
SetLayerWeight |
(layerIndex: int, weight: float) |
SetLookAtPosition |
(position: Vector3) |
SetLookAtWeight |
(weight: float) |
SetTrigger |
(name: string) |
get_angularVelocity |
|
get_applyRootMotion |
() -> bool |
get_deltaPosition |
|
get_deltaRotation |
|
get_enabled |
|
get_gameObject |
|
get_hasBoundPlayables |
|
get_hasRootMotion |
|
get_isHuman |
|
get_isMatchingTarget |
|
get_layerCount |
() -> int |
get_rootPosition |
|
get_rootRotation |
|
get_speed |
() -> float |
get_transform |
|
get_updateMode |
|
get_velocity |
|
set_applyRootMotion |
(value: bool) |
set_enabled |
|
set_rootPosition |
|
set_rootRotation |
|
set_speed |
(value: float) |
set_updateMode |
|
AnimatorStateInfo
| Member |
Signature |
IsName |
|
IsTag |
|
get_fullPathHash |
|
get_length |
|
get_loop |
|
get_normalizedTime |
|
get_shortNameHash |
|
get_speed |
|
NavMeshAgent
| Member |
Signature |
ResetPath |
() |
SetDestination |
(target: Vector3) |
get_hasPath |
() -> bool |
get_isStopped |
() -> bool |
get_remainingDistance |
() -> float |
get_speed |
() -> float |
get_velocity |
() -> Vector3 |
set_isStopped |
(value: bool) |
set_speed |
(value: float) |
set_velocity |
(value: Vector3) |
IK
| Member |
Signature |
EnableScriptControl |
() -> bool |
Audio
Guide: Audio — explanation, examples, and gotchas.
AudioSource
| Member |
Signature |
Pause |
() |
Play |
() |
PlayClipAtPoint |
|
PlayOneShot |
(clip: AudioClip) |
Stop |
() |
UnPause |
() |
get_clip |
|
get_gameObject |
|
get_isPlaying |
() -> bool |
get_loop |
() -> bool |
get_maxDistance |
|
get_minDistance |
|
get_mute |
() -> bool |
get_pitch |
() -> float |
get_playOnAwake |
|
get_spatialBlend |
|
get_time |
|
get_transform |
|
get_volume |
() -> float |
set_clip |
|
set_loop |
(value: bool) |
set_maxDistance |
|
set_minDistance |
|
set_mute |
(value: bool) |
set_pitch |
(value: float) |
set_playOnAwake |
|
set_spatialBlend |
|
set_time |
|
set_volume |
(value: float) |
AudioClip
| Member |
Signature |
get_channels |
|
get_frequency |
|
get_length |
|
get_name |
|
get_samples |
|
AudioListener
| Member |
Signature |
get_pause |
() -> bool |
get_volume |
() -> float |
set_pause |
(value: bool) |
set_volume |
(value: float) |
Guide: Input, time & camera — explanation, examples, and gotchas.
| Member |
Signature |
GetAxis |
(axisName: string) -> float |
GetAxisRaw |
(axisName: string) -> float |
GetButton |
(buttonName: string) -> bool |
GetButtonDown |
(buttonName: string) -> bool |
GetButtonUp |
(buttonName: string) -> bool |
GetKey |
(key: string) -> bool |
GetKeyDown |
(key: string) -> bool |
GetKeyUp |
(key: string) -> bool |
GetMouseButton |
(button: int) -> bool |
GetMouseButtonDown |
(button: int) -> bool |
GetMouseButtonUp |
(button: int) -> bool |
anyKey |
|
anyKeyDown |
|
get_anyKey |
() -> bool |
get_anyKeyDown |
() -> bool |
get_mousePosition |
() -> Vector3 |
mousePosition |
|
Time
| Member |
Signature |
deltaTime |
|
fixedDeltaTime |
|
frameCount |
|
get_deltaTime |
() -> float |
get_fixedDeltaTime |
() -> float |
get_frameCount |
() -> int |
get_realtimeSinceStartup |
() -> float |
get_time |
() -> float |
get_timeScale |
() -> float |
get_unscaledDeltaTime |
() -> float |
get_unscaledTime |
() -> float |
realtimeSinceStartup |
|
time |
|
timeScale |
|
unscaledDeltaTime |
|
unscaledTime |
|
Stopwatch
| Member |
Signature |
ElapsedMilliseconds |
|
Reset |
|
Restart |
|
StartNew |
|
Stop |
|
get_ElapsedMilliseconds |
|
Screen
| Member |
Signature |
get_dpi † |
() -> float |
get_fullScreen † |
() -> bool |
get_height † |
() -> int |
get_width † |
() -> int |
Camera
| Member |
Signature |
ScreenPointToRay |
(position: Vector3) -> Ray |
ScreenToWorldPoint |
(position: Vector3) -> Vector3 |
ScreenToWorldRaycast |
|
ViewportPointToRay |
|
ViewportToWorldPoint |
|
WorldToScreenPoint |
(position: Vector3) -> Vector3 |
WorldToViewportPoint |
|
allCameras |
|
allCamerasCount |
|
get_backgroundColor |
() -> Color |
get_cullingMask |
|
get_depth |
|
get_farClipPlane |
|
get_fieldOfView |
() -> float |
get_gameObject |
|
get_main |
() -> Camera |
get_nearClipPlane |
|
get_orthographic |
() -> bool |
get_orthographicSize |
() -> float |
get_transform |
|
main |
|
set_backgroundColor |
(value: Color) |
set_cullingMask |
|
set_depth |
|
set_farClipPlane |
|
set_fieldOfView |
(value: float) |
set_nearClipPlane |
|
set_orthographic |
|
set_orthographicSize |
(value: float) |
Application
| Member |
Signature |
get_isFocused † |
() -> bool |
get_isPlaying † |
() -> bool |
get_platform † |
() -> int |
Collections
Guide: Collections — explanation, examples, and gotchas.
List
| Member |
Signature |
Add |
(item: object) |
Clear |
() |
Contains |
(item: object) -> bool |
CopyTo |
|
Create † |
() -> object |
Find |
|
FindIndex |
(item: object) -> int |
Get † |
(index: int) -> object |
GetEnumerator |
|
IndexOf |
(item: object) -> int |
Insert |
(index: int, item: object) |
LastIndexOf |
|
Remove |
(item: object) |
RemoveAt |
(index: int) |
Reverse |
() |
Set † |
(index: int, value: object) |
Sort |
() |
ToArray |
() -> object |
get_Count |
() -> int |
get_Item |
|
set_Item |
|
Dictionary
| Member |
Signature |
Add |
|
Clear |
() |
ContainsKey |
(key: string) -> bool |
ContainsValue |
|
Create † |
() -> object |
Get † |
(key: string) -> object |
GetEnumerator |
|
Remove |
(key: string) |
Set † |
(key: string, value: object) |
TryGetValue |
|
get_Count |
() -> int |
get_Item |
|
get_Keys |
|
get_Values |
|
set_Item |
|
HashSet
| Member |
Signature |
Add |
|
Clear |
|
Contains |
|
ExceptWith |
|
GetEnumerator |
|
IntersectWith |
|
IsSubsetOf |
|
IsSupersetOf |
|
Overlaps |
|
Remove |
|
SetEquals |
|
SymmetricExceptWith |
|
UnionWith |
|
get_Count |
|
Queue
| Member |
Signature |
Clear |
|
Contains |
|
Dequeue |
|
Enqueue |
|
Peek |
|
get_Count |
|
Stack
| Member |
Signature |
Clear |
|
Contains |
|
Peek |
|
Pop |
|
Push |
|
get_Count |
|
KeyValuePair
| Member |
Signature |
get_Key |
|
get_Value |
|
EnumerableExtensions
| Member |
Signature |
All |
(collection: object, predicate: object) -> bool |
Any |
(collection: object, predicate: object) -> bool |
Average |
(collection: object) -> float |
Contains |
(collection: object, item: object) -> bool |
Count |
(collection: object, predicate: object) -> int |
Distinct |
(collection: object) -> object |
Except |
|
First |
(collection: object) -> object |
FirstOrDefault |
(collection: object) -> object |
Intersect |
|
Last |
(collection: object) -> object |
LastOrDefault |
(collection: object) -> object |
Max |
(collection: object) -> object |
Min |
(collection: object) -> object |
OfType |
(collection: object) -> object |
OrderBy |
(collection: object, keySelector: object) -> object |
OrderByDescending |
(collection: object, keySelector: object) -> object |
Select |
(collection: object, selector: object) -> object |
SelectMany |
|
Single |
|
SingleOrDefault |
|
Skip |
(collection: object, count: int) -> object |
SkipWhile |
|
Sum |
(collection: object) -> float |
Take |
(collection: object, count: int) -> object |
TakeWhile |
|
ToArray |
|
ToList |
(collection: object) -> object |
Union |
|
Where |
(collection: object, predicate: object) -> object |
Rendering & effects
Guide: Rendering & effects — explanation, examples, and gotchas.
Renderer
| Member |
Signature |
GetColor |
() -> Color |
SetColor |
(color: Color) |
enabled |
|
get_enabled |
() -> bool |
get_material |
() -> Material |
get_sharedMaterial |
() -> Material |
material |
|
set_enabled |
(value: bool) |
sharedMaterial |
|
SpriteRenderer
| Member |
Signature |
get_color |
() -> Color |
get_enabled |
() -> bool |
get_flipX |
() -> bool |
get_flipY |
() -> bool |
get_sortingOrder |
() -> int |
set_color |
(value: Color) |
set_enabled |
(value: bool) |
set_flipX |
(value: bool) |
set_flipY |
(value: bool) |
set_sortingOrder |
(value: int) |
Material
| Member |
Signature |
GetColor |
(name: string) -> Color |
GetFloat |
(name: string) -> float |
GetInt |
(name: string) -> int |
SetColor |
(name: string, value: Color) |
SetFloat |
(name: string, value: float) |
SetInt |
(name: string, value: int) |
color |
|
get_color |
() -> Color |
get_mainTexture |
() -> object |
mainTexture |
|
set_color |
(value: Color) |
set_mainTexture |
|
Light
| Member |
Signature |
get_color |
() -> Color |
get_enabled |
() -> bool |
get_intensity |
() -> float |
get_range |
() -> float |
get_spotAngle |
() -> float |
get_type |
() -> int |
set_color |
(value: Color) |
set_enabled |
(value: bool) |
set_intensity |
(value: float) |
set_range |
(value: float) |
set_spotAngle |
(value: float) |
ParticleSystem
| Member |
Signature |
Clear † |
() |
Emit † |
(count: int) |
Pause † |
() |
Play † |
() |
Stop † |
() |
get_isPlaying † |
() -> bool |
get_isStopped † |
() -> bool |
get_particleCount † |
() -> int |
get_time † |
() -> float |
set_time † |
(value: float) |
SpriteRegistry
| Member |
Signature |
Clear |
|
HideImage |
|
LoadFromResources |
|
SetBack |
|
SetImage |
|
ShowImage |
|
Data & web
Guide: Data & web — explanation, examples, and gotchas.
Storage
| Member |
Signature |
DeleteAll |
() |
DeleteKey |
(key: string) |
GetFloat |
(key: string, default: float) -> float |
GetInt |
(key: string, default: int) -> int |
GetString |
(key: string, default: string) -> string |
HasKey |
(key: string) -> bool |
SetFloat |
(key: string, value: float) |
SetInt |
(key: string, value: int) |
SetString |
(key: string, value: string) |
HTTP
| Member |
Signature |
Delete |
|
DeleteVia |
|
Get |
|
GetVia |
|
Patch |
|
PatchVia |
|
Post |
|
PostVia |
|
Put |
|
PutVia |
|
Secret |
|
HTTPAsyncResult
| Member |
Signature |
get_Body |
|
get_Error |
|
get_Headers |
|
get_StatusCode |
|
get_Success |
|
Json
| Member |
Signature |
FromJsonToDict |
(json: string) -> object |
Populate |
|
SerializeObject |
(obj: object) -> string |
ToJson |
(obj: object) -> string |
Primitive helpers
String
| Member |
Signature |
Compare |
|
Concat |
(a: string, b: string) -> string |
Contains † |
(value: string) -> bool |
EndsWith † |
(value: string) -> bool |
Equals |
|
Format |
(format: string, arg0: object) -> string |
IsNullOrEmpty |
(value: string) -> bool |
IsNullOrWhiteSpace |
(value: string) -> bool |
Join |
(separator: string, values: object) -> string |
Replace † |
(oldValue: string, newValue: string) -> string |
Split † |
(separator: string) -> object |
StartsWith † |
(value: string) -> bool |
Substring † |
(startIndex: int, length: int) -> string |
ToLower † |
() -> string |
ToUpper † |
() -> string |
Trim † |
() -> string |
get_Length † |
() -> int |
Boolean
| Member |
Signature |
Parse |
(s: string) -> bool |
Int32
| Member |
Signature |
Parse |
(s: string) -> int |
ToString † |
() -> string |
TryParse |
|
Int64
Single
| Member |
Signature |
Parse |
(s: string) -> float |
ToString † |
() -> string |
Double
Auto-generated from tools/api-audit/api.json — 1139 members across 104 groups. Regenerate with python tools/api-audit/gen_reference.py.