-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39 from Alpha-Blend-Interactive/develop
Community contributions, updated README.md
- Loading branch information
Showing
4 changed files
with
71 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# 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. | ||
> As of 2024r176 this component is not functional. | ||
### Properties | ||
|
||
+ **Game Instance Controller:** The Game Instance Controller component that is effected by the Control Point. | ||
+ **Reference ID:** This value is for the game server to keep track of the control point. Do not edit this value. | ||
+ **Capture Time:** The amount of time in seconds before marking the Control Point as captured. | ||
+ **Capture Bonus For Multiple People:** Will divide the Capture Time by the amount of players in the volume. | ||
+ **Recapture Delay:** The amount of time in seconds before the Control Point is able to be captured again. | ||
+ **Score Per Second:** The score that is added to the capturing Team's score per second. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# 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. | ||
|
||
### Properties | ||
|
||
+ **Particle System:** The Unity Particle system component that is used by the GameObject. | ||
+ **Shoot Sounds:** List of audio files that are randomized and used when the GameObject is shooting. | ||
+ **Reload Sounds:** List of audio files that are randomized and used when the GameObject is reloading. | ||
+ **Empty Shoot Sounds:** List of audio files that are randomized and used when the GameObject is shooting but no ammo is available. | ||
+ **Magazine Size:** The amount of ammo that is available before needing to reload. | ||
+ **Ammo Capacity:** The amount of ammo available to be reloaded into a magazine. | ||
+ **Firing Mode** | ||
- **Single:** This Firing Mode requires the the GameObject to stop shooting before being able to shoot again. | ||
- **Half Auto:** This Firing Mode will fire the amount of ammo equal to the Firing Rate property; after, the GameObject will need to stop shooting before being able to shoot again. | ||
- **Full Auto:** This Firing Mode will fire a continuous stream of ammo equal to the Firing Rate property per second; until the GameObject stops shooting, or runs out of ammo in the magazine. | ||
+ **Firing Rate:** The amount of ammo per second that can be shot. | ||
+ **Reload Time:** The amount of time in seconds that reloading the magazine takes. | ||
+ **Hit Detection:** | ||
- **Particle:** This Hit Detection will use the Particle System Collision property for collision. | ||
- **RayCast:** This Hit Detection will use a RayCast to detect collision. This is instant. | ||
+ **Hit Mask:** The Unity Collision Matrix layers that the Gun Controller can hit. | ||
|
||
### Methods | ||
These are methods that can be accessed using Custom Triggers in the Interactable component. These methods are important in order to use the Gun Controller. | ||
|
||
+ **GrantMagazineAmmo:** Will add ammo to the magazine, this will not surpass the Magazine Size property. | ||
+ **GrantReserveAmmo:** Will add ammo to the Ammo Capacity, this will not surpass the Ammo Capacity property. | ||
+ **Reload:** Will reload the magazine of the GameObject. | ||
+ **Shoot:** Will make the GameObject shoot once every time its called. | ||
+ **ShootDown:** Will make the GameObject shoot until ShootUp is called or magazine Size reaches 0. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# 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. | ||
> As of 2024r176 Text UI is limited to Unity's legacy Text UI components. This may change in the future. | ||
### Properties | ||
These are properties that are controlled by the Game Instance Controller. | ||
|
||
+ **Game Instance Controller:** The Game Instance Controller component the Score Board Controller is controlled by. | ||
+ **Round Timers:** This is a List of text components that can display the time of the current round. | ||
+ **Round Status:** This is a List of text components that can display the round status of the game. | ||
- **Waiting For Players** | ||
- **Players Ready** | ||
- **Game Starting** | ||
- **Game in Progress** | ||
+ **Team Elements:** This is a list of elements in order of the Team Index in the Game Instance Controller. | ||
- **Player Lists:** This is a list of Text components that can display player names of the players in a Team. | ||
- **Team Score:** This is a list of Text components that can display the Team's current score. |