Skip to content

Commit

Permalink
Merge pull request #41 from SketchFoxsky/SketchDocs
Browse files Browse the repository at this point in the history
Hyperlink Fixes
  • Loading branch information
loliwut authored Oct 4, 2024
2 parents c1cdff5 + 21b63c4 commit 873206a
Show file tree
Hide file tree
Showing 11 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/cck/components/CVRAssetInfo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CVR Asset Info <div class="whitelisted" data-list="AWP"></div>

The CVR Asset Info component is the component that defines the ownership and ID of an uploaded asset such as Avatars, Worlds, or Spawnables (also known as props) in our backend infrastructure. It is automatically generated as a subcomponent to the [CVR Avatar](Avatar.md), [CVR World](World.md), and [CVR Spawnable](Spawnable.md) components.
The CVR Asset Info component is the component that defines the ownership and ID of an uploaded asset such as Avatars, Worlds, or Spawnables (also known as props) in our backend infrastructure. It is automatically generated as a subcomponent to the [CVR Avatar](CVR-Avatar.md), [CVR World](CVR-World.md), and [CVR Spawnable](CVR-Spawnable.md) components.

## UI

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/cck/components/CombatSystem.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Combat System <div class="whitelisted" data-list="W"></div>
Adding this component enables PvP and PVE style gamemodes in your world. Best used alongside the **Damage** Component and the **Game Instance Controller** Component
Adding this component enables PvP and PVE style gamemodes in your world. Best used alongside the [Damage](Damage.md) Component and the [GameInstanceController](GameInstanceController.md) Component

### Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/cck/components/ControlPoint.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Control Point <div class="whitelisted" data-list="W"></div>
Adding this component to a GameObject with an IsTrigger collider will allow the player to obtain a score with the Game Instance Controller by being in the volume.
Adding this component to a GameObject with an IsTrigger collider will allow the player to obtain a score with the [GameInstanceController](GameInstanceController.md) by being in the volume.
> As of 2024r176 this component is not functional.
### Properties
Expand Down
2 changes: 1 addition & 1 deletion docs/cck/components/Damage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Damage <div class="whitelisted" data-list="W"></div>
Adding this component will allow the GameObject's collider or Particle system to inflict damage to the player; if the Combat System is present in your scene.
Adding this component will allow the GameObject's collider or Particle system to inflict damage to the player; if the [CombatSystem](CombatSystem.md) is present in your scene.

### Properties

Expand Down
6 changes: 3 additions & 3 deletions docs/cck/components/GameInstanceController.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ These are properties that control all teams and game conditions.
+ **Ready Timer** After the ready percentage has been met, this is the time in seconds before the game starts.
+ **Game Controller Type**
- **Default** Score based gamemode
- **Combat System** Elimination based gamemode
- **[Combat System](CombatSystem.md)** Elimination based gamemode
+ **Game Type**
- **Single** Each game is one round, as of game version 2024r176, Round Start and Round End Events will trigger alongside Game Start and Game End Events.
- **Rounds** Each game will consist of the amount of rounds specified in the Rounds To Win property.
Expand All @@ -37,8 +37,8 @@ These are properties that control all teams and game conditions.
- **Score** When a Team accumulates a score defined by the End Score property, the game or round will end.
- **Time** When the time in seconds defined in the End Time property is reached, the game or round will end.
- **Time or Score** When the Time or Score end condition is met, the game or round will end.
- **Elimination** A combat system only Game Type end condition. When only 1 team is remaining, the game or round will end.
- **Time or Elimination** A combat system only Game Type end condition. When the Time or Elimination end condition is met, the game or round will end.
- **Elimination** A [Combat System](CombatSystem.md) only Game Type end condition. When only 1 team is remaining, the game or round will end.
- **Time or Elimination** A [Combat System](CombatSystem.md) only Game Type end condition. When the Time or Elimination end condition is met, the game or round will end.
+ **End Score** The score required to win a round or game.
+ **End Time** The amount of time in seconds before a round or game ends.

Expand Down
2 changes: 1 addition & 1 deletion docs/cck/components/GunController.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Gun Controller <div class="whitelisted" data-list="W"></div>
This component is used as a quick way to make a ranged weapon for the Combat System.
This component is used as a quick way to make a ranged weapon for the [Combat System](CombatSystem.md).

### Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/cck/components/ObjectHealth.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Object Health <div class="whitelisted" data-list="W"></div>
Adding this component gives the GameObject properites for the Combat System. Best used alongside the **Damage** and **Game Instance Controller** components.
Adding this component gives the GameObject properites for the Combat System. Best used alongside the [Damage](Damage.md) and [GameInstanceController](GameInstanceController.md) components.

### Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/cck/components/ScoreBoardController.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Score Board Controller <div class="whitelisted" data-list="W"></div>
Adding this component will allow you to display information about the Game Instance Controller in a Unity UI Canvas.
Adding this component will allow you to display information about the [GameInstanceController](GameInstanceController.md) in a Unity UI Canvas.
> As of 2024r176 Text UI is limited to Unity's legacy Text UI components. This may change in the future.
### Properties
Expand Down

0 comments on commit 873206a

Please sign in to comment.