Yuari
Documentation
Docs/Instances/getsimulationradius

getsimulationradius

Reads or overrides the simulation radius.

Syntax

getsimulationradius() -> number

Parameters

This function takes no parameters.

Returns

TypeDescription
numberThe returned number.

Description

getsimulationradius is part of the Instances library. Instance helpers traverse the live DataModel and return instance proxies tied to the current game session.

The call is read-only: it resolves the current value when invoked and does not change the underlying state.

The aliases setsimulationradius(radius) resolve to the same implementation.

Example

print(getsimulationradius())
setsimulationradius(1000)

Notes

  • Aliases: setsimulationradius(radius).
  • Returned instances are live proxies; they can become invalid if the object is destroyed.