mirror
/
tile38
mirror of https://github.com/tidwall/tile38.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated DETECT option details to README

This commit is contained in:
Josh Baker 2016-06-10 14:52:11 -07:00
parent 80c4e663bc
commit 6c0efdd46f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -175,11 +175,13 @@ The server will notify the client if the `command` is `del | set | drop`.
- `drop` notifies the client that the entire collection is dropped. - `drop` notifies the client that the entire collection is dropped.
- `set` notifies the client that an object has been added or updated, and when it's position is detected by the fence. - `set` notifies the client that an object has been added or updated, and when it's position is detected by the fence.
The `detect` may be `enter | exit | cross`. The `detect` may be one of the following values.
- `inside` is when an object is inside the specified area.
- `outside` is when an object is outside the specified area.
- `enter` is when an object that **was not** previously in the fence has entered the area. - `enter` is when an object that **was not** previously in the fence has entered the area.
- `exit` is when an object that **was** previously in the fence has exited the area. - `exit` is when an object that **was** previously in the fence has exited the area.
- `cross` is when an object that **was not** previously in the fence has entered and exited the area. - `cross` is when an object that **was not** previously in the fence has entered **and** exited the area.
## Object types ## Object types