Datatype · Structs

EntitySnapshot

struct

Single row returned by entity.get_entities. Reflects the live state at call time; consecutive calls may return different rows as characters spawn or despawn.

Fields

Name	Type	Description
Character	Instance?	Character model, or `nil` if it was destroyed since resolution.
DisplayName	string?	Underlying player's display name when the entity is a Player.
Head	BasePart?	Head part, if present.
Health	number?	Current `Humanoid.Health`, or `nil` when there is no Humanoid.
Humanoid	Humanoid?	Character's `Humanoid`, if present.
IsBot	boolean	`true` when the entity was classified as a non-player character.
Kind	EntityKind	Classification: `Player`, `NPC`, or `Unknown`.
MaxHealth	number?	Current `Humanoid.MaxHealth`, or `nil` when there is no Humanoid.
Player	RbxPlayer?	Live Player userdata when the entity resolves to a real player. Independent of `Kind` - player-puppeted NPCs surface here too.
PrimaryPart	BasePart?	Primary part (`HumanoidRootPart` for R15, `Torso` for R6).
Relation	EntityRelation	Relation to the local player.
TeamColor	Color4?	Resolved team colour, or `nil` when no team rule applied.
TeamName	string?	Resolved team name, or `nil` when no team rule applied.
Username	string?	Underlying player's username when the entity is a Player.