> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ss14.art/llms.txt
> Use this file to discover all available pages before exploring further.

# Entity commands

## Sources

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>entities</h3>
  </div>

  <div style={{textAlign: "right"}}>
    `[none] -> IEnumerable<EntityUid>`
  </div>
</div>

Returns a list of all entities in the simulation.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>ent \<entity></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `[none] -> EntityUid`
  </div>
</div>

Returns the given entity.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>spawn:at \<entity prototype></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityCoordinates> -> IEnumerable?<EntityUid>`
  </div>
</div>

Spawns a new entity at the given coordinates.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>spawn:on \<entity prototype></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Spawns a new entity on the other given entity.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>spawn:attached \<entity prototype></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Spawns a new entity attached to the other given entity.

## Filters

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>with \<component type></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable<EntityUid> -> IEnumerable<EntityUid>`
  </div>
</div>

Filters the input for entities with some given component.
This command can be inverted with `not`.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>prototyped \<prototype></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable<EntityUid> -> IEnumerable<EntityUid>`
  </div>
</div>

Filters the input for entities built from a given prototype.
This command can be inverted with `not`.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>paused</h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable<EntityUid> -> IEnumerable<EntityUid>`
  </div>
</div>

Filters the input for entities that are currently paused.
This command can be inverted with `not`.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>nearby \<range></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable<EntityUid>`
  </div>
</div>

Filters for entities nearby the inputs, returning all entities within range of it.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>named \<name></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable<EntityUid> -> IEnumerable<EntityUid>`
  </div>
</div>

Filters the input for entities with a name matching the regex `$regex^`.

## Transforms

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>comp:has \<component type></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<bool>`
  </div>
</div>

Returns true if the input entity has the given component, otherwise false.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>pos</h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityCoordinates>`
  </div>
</div>

Returns the coordinates of the input entities, relative to their parent.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>mappos</h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityCoordinates>`
  </div>
</div>

Returns the coordinates of the input entities, relative to the map.

## Mutators

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>delete</h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable<EntityUid> -> [none]`
  </div>
</div>

Deletes the inputs from the simulation. Gone. Poof.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>replace \<entity prototype></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Replaces the given entities with another of some prototype, preserving only it's position and rotation.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>tp:coords \<entity coordinates></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Teleports the input to the given coordinates.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>tp:to \<entity></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Teleports the input to the given entity.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>tp:into \<entity></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Teleports the input into the given entity.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>comp:add \<component type></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Adds the given component to the entity.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>comp:ensure \<component type></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Ensures the input has the given component.

<div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
  <div>
    <h3>comp:rm \<component type></h3>
  </div>

  <div style={{textAlign: "right"}}>
    `IEnumerable?<EntityUid> -> IEnumerable?<EntityUid>`
  </div>
</div>

Removes the given component from the entity.