# SAvatar

## Index

### Properties Index

| Property                                   |
| ------------------------------------------ |
| int [**ID**](#id) `get`                    |
| Vector3 [**Position** ](#position)`get`    |
| Vector3 [**Velocity** ](#velocity)`get`    |
| Quaternion [**Rotation** ](#rotation)`get` |
| string [**Username** ](#username)`get`     |
| string [**Title** ](#title)`get`           |

## Properties

### ID

int **ID** `get`

*Avatar's ID*

{% tabs %}
{% tab title="Lua" %}

```lua
ID = Space.Scene.Avatars[1].ID
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--server script that prints a list of IDs of players online whenever someone joins
function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars

  for num =1 , numOfAvatars, 1 do
    Space.Log(Space.Scene.Avatars[num].ID)
  end
end
```

{% endtab %}
{% endtabs %}

### Position

Vector3 **Position** `get`

*Avatar's position*

{% tabs %}
{% tab title="Lua" %}

```lua
ID = Space.Scene.Avatars[1].Position
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--server script that prints a list of Positions of players online whenever someone joins
function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars

  for num =1 , numOfAvatars, 1 do
    Space.Log(Space.Scene.Avatars[num].Position)
  end
end
```

{% endtab %}
{% endtabs %}

### Velocity

Vector3 **Velocity** `get`

*Avatar's Velocity*

{% tabs %}
{% tab title="Lua" %}

```lua
ID = Space.Scene.Avatars[1].Velocity
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--server script that prints a list of Velocitys of players online whenever someone joins
function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars

  for num =1 , numOfAvatars, 1 do
    Space.Log(Space.Scene.Avatars[num].Velocity)
  end
end
```

{% endtab %}
{% endtabs %}

### Rotation

Quaternion **Rotation** `get`

*Avatar's Rotation*

{% tabs %}
{% tab title="Lua" %}

```lua
ID = Space.Scene.Avatars[1].Quaternion 
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--server script that prints a list of Rotations of players online whenever someone joins
function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars

  for num =1 , numOfAvatars, 1 do
    Space.Log(Space.Scene.Avatars[num].Rotation)
  end
end
```

{% endtab %}
{% endtabs %}

### Username

string **Username** `get`

*Avatar's Username*

{% tabs %}
{% tab title="Lua" %}

```lua
ID = Space.Scene.Avatars[1].Username
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--server script that prints a list of Usernames of players online whenever someone joins
function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars

  for num =1 , numOfAvatars, 1 do
    Space.Log(Space.Scene.Avatars[num].Username)
  end
end
```

{% endtab %}
{% endtabs %}

### Title

string **Title** `get`

*Avatar's Title*

{% tabs %}
{% tab title="Lua" %}

```lua
ID = Space.Scene.Avatars[1].Title
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Lua" %}

```lua
--server script that prints a list of Titles of players online whenever someone joins
function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars

  for num =1 , numOfAvatars, 1 do
    Space.Log(Space.Scene.Avatars[num].Title)
  end
end
```

{% endtab %}
{% endtabs %}
