Scene
extends Out
in package
A lightweight, read-only wrapper around a single `GET /scene` response (the `SceneOut` schema): the 3D World-tab scene graph.
The biomes/deposits static layers are sent only for ?static=1
(see WorldRepository::getScene()) and are null
otherwise — do not treat a missing layer as "empty".
Tags
Table of Contents
Properties
- $agents : array<string|int, mixed>
- $artifacts : array<string|int, mixed>|null
- $asteroids : array<string|int, mixed>|null
- $biomes : array<string|int, mixed>|null
- $bombs : array<string|int, mixed>|null
- $deposits : array<string|int, mixed>|null
- $geese : array<string|int, mixed>|null
- $h : int
- $loading : bool
- $storm : array<string|int, mixed>|object|null
- $structures : array<string|int, mixed>|null
- $vehicles : array<string|int, mixed>|null
- $w : int
- $fillable : mixed
Methods
- fill() : void
- Stores the full decoded payload, then applies any declared attribute mutators. Unlike the parent, keys absent from `$fillable` are preserved so the model tolerates the extra keys the NHA API is allowed to add.
- jsonSerialize() : array<string|int, mixed>
- Serialises back to the full raw payload (lossless), not just the declared subset, so round-tripping an NHA response never discards fields.
Properties
$agents
public
array<string|int, mixed>
$agents
Agents in the scene.
$artifacts
public
array<string|int, mixed>|null
$artifacts
Ancient artifacts.
$asteroids
public
array<string|int, mixed>|null
$asteroids
Dockable asteroids (space era).
$biomes
public
array<string|int, mixed>|null
$biomes
Static biome polygons (only with ?static=1).
$bombs
public
array<string|int, mixed>|null
$bombs
Armed/placed bombs.
$deposits
public
array<string|int, mixed>|null
$deposits
Static deposit markers (only with ?static=1).
$geese
public
array<string|int, mixed>|null
$geese
Roaming geese.
$h
public
int
$h
Scene height.
$loading
public
bool
$loading
Whether the scene is still building.
$storm
public
array<string|int, mixed>|object|null
$storm
Active storm cell, if any.
$structures
public
array<string|int, mixed>|null
$structures
Placed structures.
$vehicles
public
array<string|int, mixed>|null
$vehicles
Vehicles in the scene.
$w
public
int
$w
Scene width.
$fillable
protected
mixed
$fillable
= ['w', 'h', 'agents', 'loading', 'biomes', 'deposits', 'structures', 'vehicles', 'artifacts', 'asteroids', 'geese', 'bombs', 'storm']
Tags
Methods
fill()
Stores the full decoded payload, then applies any declared attribute mutators. Unlike the parent, keys absent from `$fillable` are preserved so the model tolerates the extra keys the NHA API is allowed to add.
public
fill(array<string|int, mixed> $attributes) : void
Parameters
- $attributes : array<string|int, mixed>
-
The decoded response body.
jsonSerialize()
Serialises back to the full raw payload (lossless), not just the declared subset, so round-tripping an NHA response never discards fields.
public
jsonSerialize() : array<string|int, mixed>