Skip to content
Draft

0.8 #105

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/img/previews/ar_controller.png
Binary file not shown.
Binary file removed docs/img/previews/ar_goggles.png
Binary file not shown.
12 changes: 12 additions & 0 deletions docs/integrations/ae2/cable_p2p_tunnel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
comments: true
---

# Cable P2P Tunnel

!!! picture inline end
![!Images of Cable P2P Tunnel](../img/previews/cable_p2p_tunnel.png){ align=right }

Cable P2P Tunnel is created by right clicking a P2P tunnel with CC: Tweaked's cable or wired modems.
It allows you control peripherals wirely across dimensions.
The in and out direction does not matter when connecting.
24 changes: 0 additions & 24 deletions docs/items/ar_goggles.md

This file was deleted.

23 changes: 23 additions & 0 deletions docs/items/smart_glasses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
comments: true
---

# Smart Glasses

!!! picture inline end
![!Image of the Smart Glasses item](../img/previews/smart_glasses.png){ align=right }

The Smart Glasses can be used as an advanced pocket computer worn on the head,
equipped with most peripherials and various [modules](../modules)!

You can access Smart Glasses worn on the head via a [Smart Glasses Interface](./smart_glasses_interface.md).

---

## Changelog/Trivia

**0.8**
Completely reworked AR Goggles and renamed it to Smart Glasses

**0.5b**
Added the AR Controller and AR Goggles, made by Olfi01#6413
17 changes: 17 additions & 0 deletions docs/items/smart_glasses_interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
comments: true
---

# Smart Glasses Interface

!!! picture inline end
![!Image of the Smart Glasses Interface item](../img/previews/smart_glasses_interface.png){ align=right }

The Smart Glasses Interface let you access wearing [Smart Glasses](./smart_glasses.md) by righting the item.

---

## Changelog/Trivia

**0.8**
Completely reworked AR Goggles and renamed it to Smart Glasses
34 changes: 34 additions & 0 deletions docs/modules/hotkey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
comments: true
---

# Hotkey Module

!!! picture inline end
![!Image of the Hotkey Module item](../img/previews/modules/hotkey_module.png){ align=right }

The Hotkey Module can listen to the hotkey that players bound in their client.
Hotkey is configurable at player's client.

---

## Events

### glasses_key_pressed

Fires when the player pressed the hotkey.
**Values:**
1. `keyBind: string` The hotkey the player bound to.
2. `keyPressDuration: number` The duration the hotkey was held down, in milliseconds.

```lua linenums="1"
local event, keyBind, keyPressDuration = os.pullEvent("glasses_key_pressed")
print("The hotkey " .. keyBind .. " pressed for " .. keyPressDuration .. "ms")
```

---

## Changelog/Trivia

**0.8**
Added Hotkey Module
40 changes: 40 additions & 0 deletions docs/modules/night_vision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
comments: true
---

# Night Vision Module

!!! picture inline end
![!Image of the Night Vision Module item](../img/previews/modules/night_vision_module.png){ align=right }

The Night Vision Module can provide an infinite night vision effect to the wearer.
The night vision effect will be enabled by default.

While Night Vision Module is disabled, night vision potion does not take any effect.

---

## Functions

### isNightVisionEnabled
```
isNightVisionEnabled() -> boolean
```

Returns if the night vision effect is enabled.

---

### enableNightVision
```
enableNightVision(enable: boolean) -> nil
```

If passed value is `true`, it will start applying night vision effect, `false` to start clearing any night vision effect.

---

## Changelog/Trivia

**0.8**
Added Night Vision Module
Loading