Skip to content

Commit 130d2b5

Browse files
committed
Add readme dalam bahasa
1 parent fc24811 commit 130d2b5

File tree

2 files changed

+78
-15
lines changed

2 files changed

+78
-15
lines changed

README-ID.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Generic Messaging System
2+
------
3+
**Generic Messaging System** adalah messaging system untuk Unity game engine untuk menangani interaksi antar objek dengan menggunakan messaging yang menggunakan generic untuk menyimpan objek dari handler.
4+
5+
## Penggunaan
6+
1. Download *.unitypackage dari [Halaman Release](../../releases)
7+
2. Import ke project unity anda
8+
3. Buat kelas baru yang meng-extend kelas BaseMessagingManager
9+
4. Overite abstract method **BaseMessagingManager.CreateAllStorage()** dan **BaseMessagingManager.DestroyAllStorage()** dan dengan menggunakan fungsi dibawah ini untuk membuat/menghapus penyimpanan objek :
10+
```
11+
Kelas : BaseMessagingManager
12+
13+
public void CreateStorage<D, I>() where D : IMessageDomain where I : IMessageListener
14+
15+
public void DestroyStorage<D, I>() where D : IMessageDomain where I : IMessageListener
16+
```
17+
18+
5. Buat interface baru yang meng-extend IMessageListener
19+
6. Buat interface baru yang meng-extend IMessageDomain untuk membuat domain baru atau gunakan GlobalDomain yang telah ada
20+
7. Buat kelas baru yang mengimplementasikan IMessageListener sebagai kelas yang akan menangani message (handler)
21+
8. Tambah/hapus handler ke/dari manager dengan memanggil fungsi Add/Remove dari kelas yang meng-extend BaseMessagingManager :
22+
```
23+
class : BaseMessagingManager
24+
25+
public void Add<D, I>(I handler) where D : IMessageDomain where I : IMessageListener
26+
27+
public void Remove<D, I>(I handler) where D : IMessageDomain where I : IMessageListener
28+
```
29+
9. Broadcast message dengan menggunkan:
30+
```
31+
class : BaseMessagingManager
32+
33+
public void Broadcast<D, I>(Action<I> action) where D : IMessageDomain where I : IMessageListener
34+
35+
public IEnumerator BroadcastAsync<D, I>(Action<I> action) where D : IMessageDomain where I : IMessageListener
36+
```
37+
38+
Untuk lebih detail, silahkan liat pada contoh scene yang sudah ada.
39+
40+
## Contribution
41+
Silahkan baca [CONTRIBUTION.md](./CONTRIBUTION.md) untuk informasi lebih detail untuk ikut berkontribusi.
42+
43+
## Licenses
44+
Silahkan baca [LICENSE](./LICENSE) untuk informasi lebih tentang license.
45+
46+
## Bahasa
47+
* [README(ENGLISH)](./README.md)
48+
* [README(BAHASA)](./README-ID.md)

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,49 @@
11
# Generic Messaging System
22
------
3-
**Generic Messaging System** adalah messaging system for Unity game engine which implementing Generic class to store instance of handler.
3+
**Generic Messaging System** is messaging system for Unity game engine which implementing Generic class to store instance of handler.
44

55
## How to use
6-
1. Download *.unitypackage release from [Release Page](../../releases)
7-
2. Import to your Unity project
8-
3. Create New Class which extending BaseMessagingManager class
9-
4. Overite abstract method **BaseMessagingManager.CreateAllStorage()** and **BaseMessagingManager.DestroyAllStorage()** using method :
10-
6+
1. Download *.unitypackage from [Release Page](../../releases)
7+
2. Import to your unity project
8+
3. Create new class which extending BaseMessagingManager class
9+
4. Overite abstract method **BaseMessagingManager.CreateAllStorage()** and **BaseMessagingManager.DestroyAllStorage()** and using method bellow to create/destroy storage :
1110
```
12-
BaseMessagingManager.CreateStorage<D, I>() where D : IMessageDomain where I : IMessageListener
11+
class : BaseMessagingManager
12+
13+
public void CreateStorage<D, I>() where D : IMessageDomain where I : IMessageListener
1314

14-
BaseMessagingManager.DestroyStorage<D, I>() where D : IMessageDomain where I : IMessageListener
15+
public void DestroyStorage<D, I>() where D : IMessageDomain where I : IMessageListener
1516
```
1617

17-
5. Create Interface which extending IMessageListener
18-
6. Create Interface which extending IMessageDomain or use GlobalDomain
19-
7. Create new class which extend IMessageListener and Add or Remove its instrance using :
20-
18+
5. Create interface which extending IMessageListener
19+
6. Create interface which extending IMessageDomain to create new domain or use GlobalDomain
20+
7. Create new class which extend IMessageListener as handler class
21+
8. Add/Remove instance of handler using:
2122
```
22-
BaseMessagingManager.Add<D, I>(I handler) where D : IMessageDomain where I : IMessageListener
23+
class : BaseMessagingManager
2324

24-
BaseMessagingManager.Remove<D, I>(I handler) where D : IMessageDomain where I : IMessageListener
25+
public void Add<D, I>(I handler) where D : IMessageDomain where I : IMessageListener
26+
27+
public void Remove<D, I>(I handler) where D : IMessageDomain where I : IMessageListener
28+
```
29+
9. Broadcast message using:
30+
```
31+
class : BaseMessagingManager
32+
33+
public void Broadcast<D, I>(Action<I> action) where D : IMessageDomain where I : IMessageListener
34+
35+
public IEnumerator BroadcastAsync<D, I>(Action<I> action) where D : IMessageDomain where I : IMessageListener
2536
```
2637

27-
Please look at Sample for more detail
38+
Please look at sample for more detail.
2839

2940
## Contribution
3041
Please read [CONTRIBUTION.md](./CONTRIBUTION.md) file for detail about contribution.
3142

3243
## Licenses
3344
Please read [LICENSE](./LICENSE) file for detail about lincese.
3445

46+
## Language
47+
* [README(ENGLISH)](./README.md)
48+
* [README(BAHASA)](./README-ID.md)
49+

0 commit comments

Comments
 (0)