Skip to content

Commit f6168d1

Browse files
authored
Update README.md
1 parent d096156 commit f6168d1

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# Unity-Object-Pool
2-
A singleton object pooler for all of your optimization needs
2+
A singleton object pooler for all of your optimization.
3+
Currently to get the Object you need to know the position in the pool, will be changed to either use the position or the name.
4+
5+
## In the Editor
6+
![image](https://user-images.githubusercontent.com/32739337/102151045-4fa96100-3e48-11eb-9bed-7c8a8cb7eb8f.png)
7+
8+
Here we have the option to enable debugging and to assign new objects to the pool
9+
10+
## Assigning new Objects to the pool
11+
![image](https://user-images.githubusercontent.com/32739337/102151204-b890d900-3e48-11eb-9eb3-d1654fcea0c7.png)
12+
13+
### Assignables
14+
Set the name you want to use for retrieving the GameObject from the pool
15+
16+
Set the initial amount you want to be created.
17+
18+
Set the GameOject to be pooled
19+
20+
### Settings
21+
22+
If you enable Load More If None Left, then if the pool runs out of the object you want, it will create a new one and add it to the pool
23+
24+
## Debugging
25+
When Debug is enabled it gives more information on what is happening
26+
27+
![image](https://user-images.githubusercontent.com/32739337/102151501-6ef4be00-3e49-11eb-8320-d3e5529cddf4.png)
28+
![image](https://user-images.githubusercontent.com/32739337/102151883-3b666380-3e4a-11eb-85bf-440009247c92.png)

0 commit comments

Comments
 (0)