Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SixWays authored Sep 11, 2018
1 parent 952e654 commit 0b6f570
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Relay
Fast, light, GC-friendly C# signals/events for Unity.

### !! BREAKING CHANGE !!
Relay.RemoveAll now defaults to removing persistent *and* one-time listeners.
`RemoveAll(bool removePersistentListeners=true, bool removeOneTimeListeners=true)`

---

C# `event` multicasting is a nice language-level feature, but in Unity's version of Mono, events allocate a lot on addition/removal and aren't always easy to manipulate. Relay aims to address these issues.
Expand Down Expand Up @@ -49,4 +45,4 @@ All other operations are allocation-free. Note that this is *worst-case* GC perf

Note: Under .NET 4.6 `event` addition and removal is 2-7x faster than under Unity.

Perf tests and unit tests are included in Relay/Editor.
Perf tests and unit tests are included in Relay/Editor.

0 comments on commit 0b6f570

Please sign in to comment.