Mirror/doc/Articles/Guides/Sync/SyncHashSet.md

70 lines
2.1 KiB
Markdown
Raw Normal View History

2019-03-22 13:51:29 +00:00
# SyncHashSet
2019-06-25 05:59:13 +00:00
`SyncHashSet` are sets similar to C\# [HashSet\<T\>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.hashset-1) that synchronize their contents from the server to the clients.
2019-09-21 03:34:03 +00:00
A SyncHashSet can contain any [supported mirror type](../DataTypes.md)
## Usage
2020-10-02 18:56:20 +00:00
Add a SyncHashSet field to your NetworkBehaviour class. For example:
2019-07-07 05:52:37 +00:00
```cs
2020-01-15 00:42:04 +00:00
public class Player : NetworkBehaviour {
2020-01-15 00:42:04 +00:00
[SerializeField]
2020-10-02 18:56:20 +00:00
readonly SyncHashSet<string> skills = new SyncHashSet<string>();
int skillPoints = 10;
[Command]
public void CmdLearnSkill(string skillName)
{
if (skillPoints > 1)
{
skillPoints--;
skills.Add(skillName);
}
}
}
```
You can also detect when a SyncHashSet changes. This is useful for refreshing your character in the client or determining when you need to update your database.
Subscribe to the Callback event typically during `Start`, `OnClientStart` or `OnServerStart` for that.
2019-08-20 13:29:55 +00:00
> Note that by the time you subscribe, the set will already be initialized, so you will not get a call for the initial data, only updates.</p>
>Note SyncSets must be initialized in the constructor, not in Startxxx(). You can make them readonly to ensure correct usage.
2019-07-07 05:52:37 +00:00
```cs
2020-01-15 00:42:04 +00:00
public class Player : NetworkBehaviour
{
[SerializeField]
2020-10-02 18:56:20 +00:00
public readonly SyncHashSet<string> buffs = new SyncHashSet<string>();
// this will add the delegate on the client.
// Use OnStartServer instead if you want it on the server
public override void OnStartClient()
{
buffs.Callback += OnBuffsChanged;
}
2020-10-02 18:56:20 +00:00
void OnBuffsChanged(SyncHashSet<string>.Operation op, string buff)
{
switch (op)
{
2020-10-02 18:56:20 +00:00
case SyncHashSet<string>.Operation.OP_ADD:
// we added a buff, draw an icon on the character
break;
2020-10-02 18:56:20 +00:00
case SyncHashSet<string>.Operation.OP_CLEAR:
// clear all buffs from the character
break;
2020-10-02 18:56:20 +00:00
case SyncHashSet<string>.Operation.OP_REMOVE:
// We removed a buff from the character
break;
}
}
}
```