# SBoxCollider

## Index

### Properties Index

| Property Name                                |
| -------------------------------------------- |
| SVector [**Center** ](#center)`get` `set`    |
| SVector [**Size** ](#size)`get` `set`        |
| bool [**Enabled** ](#enabled)`get` `set`     |
| bool [**IsTrigger** ](#istrigger)`get` `set` |

## Properties

### Center

[SVector](https://docs.sine.space/scripting/client-scripting-api-reference/types/svector) **Center** `get` `set`

*The position of the center of the Box Collider.*

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

```lua
Center = Space.Host.ExecutingObject.BoxCollider.Center
```

{% endtab %}
{% endtabs %}

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

```lua
--clicking this object moves it's Box Collider's center one unit upwards

thisObject = Space.Host.ExecutingObject

OnClick = function()
center = thisObject.BoxCollider.Center

thisObject.BoxCollider.Center = Vector.New(center.X,center.Y + 1, center.Z)

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### Size

[SVector](https://docs.sine.space/scripting/client-scripting-api-reference/types/svector) **Size** `get` `set`

*The size of the box.*

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

```lua
Size= Space.Host.ExecutingObject.BoxCollider.Size
```

{% endtab %}
{% endtabs %}

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

```lua
--clicking this object increases it's Box Collider's size by one unit

thisObject = Space.Host.ExecutingObject

OnClick = function()
size = thisObject.BoxCollider.Size

thisObject.BoxCollider.Size = Vector.New(size.X + 1,size.Y + 1, size.Z + 1)

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### Enabled

bool **Enabled** `get` `set`

*Enabled Colliders will collide with other Colliders, disabled Colliders won't.*

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

```lua
Space.Host.ExecutingObject.BoxCollider.Enabled = false
```

{% endtab %}
{% endtabs %}

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

```lua
--clicking this object toggles it's Box Collider On/Off

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.BoxCollider.Enabled = not thisObject.BoxCollider.Enabled

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### IsTrigger

bool **IsTrigger** `get` `set`

*Is the collider a trigger?*

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

```lua
Space.Host.ExecutingObject.BoxCollider.Enabled = true
```

{% endtab %}
{% endtabs %}

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

```lua
--clicking this object toggles it's Box Collider between being a Collider and Trigger Collider

thisObject = Space.Host.ExecutingObject

OnClick = function()
thisObject.BoxCollider.IsTrigger = not thisObject.BoxCollider.IsTrigger

end

thisObject.AddClickable() 
thisObject.Clickable.OnClick(OnClick)
```

{% endtab %}
{% endtabs %}

### GameObject

[SGameObject](https://docs.sine.space/scripting/client-scripting-api-reference/types/sgameobject) **GameObject** `get`

*Returns a reference to the GameObject of this component.*

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

```lua
theGameObject = Space.Host.ExecutingObject.BoxCollider.GameObject
```

{% endtab %}
{% endtabs %}