<!-- Page: https://rustic-game-engine.pages.dev/docs/api/properties/get-property -->

# rustic.get_property()

[Public properties](https://rustic-game-engine.pages.dev/markdown/api/properties.md)

## Compatibility

**Supported languages:** C, C++, C#, Python, JavaScript, Lua 5.4, Luau, Java, PHP and HTML/inline JavaScript (binding spellings and return shapes differ).

Use a compatible native engine build and the language tools required by your binding. This does not establish browser/mobile export or release qualification for every OS.

The signature below is the shared reference notation; language examples show the actual binding syntax. Question marks mark optional arguments and explicit defaults are shown where recorded. Do not copy reference notation as a typed declaration.

See [Feature status and compatibility](https://rustic-game-engine.pages.dev/markdown/reference/compatibility.md) for API 1.0/1.1 and per-method restrictions. Engine release tags and Docs v0.1 are independent versions.

## Signature

`rustic.get_property(name)`

## Setup and usage

Use properties for designer-configurable values such as speed, health, and damage. Read at setup or when needed; write only when gameplay changes the value.

## Parameters

| Variable | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Exact declared property name. |

## Return and timing

Get returns the stored value. Set cannot create a missing property. Its write timing follows the [runtime execution rules](https://rustic-game-engine.pages.dev/markdown/guides/scripting.md#when-mutations-take-effect).

## Execution behavior

Core write timing differs between immediate Lua host calls, deferred JavaScript/Web commands and external SDK query flushes. Scheduled actions advance with the scene clock; synchronous queries evaluate at the call. Follow [execution rules](https://rustic-game-engine.pages.dev/markdown/guides/scripting.md#when-mutations-take-effect) and the return/timing notes for this category.

## Language examples

Use these snippets inside Start/on_start after generating the Programming Workspace and attaching the script. Python imports rustic, Game and instance from rustic; C++ includes rustic.hpp; C includes rustic.h; C# uses using static Rustic; Java runs inside a Rustic subclass; PHP declares global $rustic, $Game, $instance in its callback. HTML uses an inline script in a ui/ asset. See [Lifecycle callbacks](https://rustic-game-engine.pages.dev/markdown/callbacks.md) for complete registration examples. Public-property examples require a declared integer health property. Scene examples require the named objects to exist before Play.

### Lua 5.4

```lua
local health = rustic.get_property('health')
rustic.set_property('health', health - 10)
```

### JavaScript

```javascript
const health = rustic.get_property('health');
rustic.set_property('health', health - 10);
```

### Python

```python
health = rustic.get_property('health')
rustic.set_property('health', health - 10)
```

### C++

```cpp
double health = rustic.get_property("health").number();
rustic.set_property("health", RusticValue{health - 10});
```

### C#

```csharp
long health = (long)rustic.get_property("health")!;
rustic.set_property("health",health-10);
```

### Luau

```lua
local health = rustic.get_property('health')
rustic.set_property('health',health-10)
```

### C

```c
RusticValue health = rustic.get_property("health");
health.integer -= 10;
rustic.set_property("health",health);
```

### Java

```java
long health = ((Number)rustic.get_property("health")).longValue();
rustic.set_property("health",health-10);
```

### PHP

```php
$health = $rustic->get_property("health");
$rustic->set_property("health",$health-10);
```

### HTML / inline JS

```javascript
const health = rustic.get_property('health');
rustic.set_property('health', health - 10);
```

## Shared Public properties constraints

- Unknown names and type changes are rejected. Boundary values are booleans, integers, finite numbers, strings, vectors, and optional entity IDs.
- Every gameplay language calls the engine-owned API. Rustic supplies SDKs and dispatches callbacks; scripts do not parse requests or serialize responses. See the language guide for complete setup and callback registration.

## Errors and debugging

Read the constraints above and the Console diagnostic. Invalid types, non-finite values, stale targets or unavailable native services can fail validation. A failed callback disables the behavior; a failed source reload keeps the last good instance. Exact error messages depend on the language adapter. See [Troubleshooting](https://rustic-game-engine.pages.dev/markdown/troubleshooting.md).

## Related APIs

- [rustic.set_property()](https://rustic-game-engine.pages.dev/markdown/api/properties/set-property.md)

[All properties APIs](https://rustic-game-engine.pages.dev/markdown/api/properties.md)