Datatype · Userdata

EntitySpecification

userdata

Luau-driven entity specification returned by entity.create_specification. Each tick the entity subsystem invokes GetCharacters on the VM thread, caches the returned entries, and merges them into entity.get_entities.

Mutate Enabled and GetCharacters directly on the proxy; call :Delete() to remove the specification.

Fields

Name	Type	Description
Delete	(self: EntitySpecification) -> ()	Removes the specification immediately. Equivalent to `entity.delete_specification(spec)`.
Enabled	boolean	When `true`, the subsystem invokes `GetCharacters` each tick. Assign a boolean to toggle.
GetCharacters	(() -> { EntitySpecificationEntry })?	Callback invoked once per tick on the VM thread. Returns the current entry list. Assign a function to replace; assign `nil` to clear.
Name	string	Read-only. The name supplied to `entity.create_specification`.