Reference/Datatypes/EntitySpecificationEntry
Datatype · Structs

EntitySpecificationEntry

struct

Single entity row returned by an EntitySpecification.GetCharacters callback. Only CharacterRoot is required; everything else has a sensible default. When AssociatedPlayer is set, Username, DisplayName, TeamName, and TeamColor are taken from the live Player and override any values supplied here.

Fields

NameTypeDescription
AssociatedPlayerRbxPlayer?

Links this entry to a live Player. When set, the player's Username, DisplayName, TeamName and TeamColor override the values supplied above.

CharacterRootInstance

Required. The character root instance the rest of the entry is anchored to.

CustomBones{ { BasePart, BasePart } }?

Override the auto-derived bone pair list. Each pair is { from, to }.

HumanoidHumanoid?

Optional explicit Humanoid. Auto-resolved when omitted.

Namestring?

Override the display / username. Defaults to CharacterRoot.Name.

PrimaryPartBasePart?

Optional explicit primary part. Auto-resolved when omitted.

RelationEntityRelation?

Defaults to Neutral.

TeamColorColor4?

Override the team colour. Ignored when AssociatedPlayer is set.

TeamNamestring?

Override the team label. Ignored when AssociatedPlayer is set.

TypeEntityKind?

Defaults to NPC.