Commit Graph

138 Commits

Author SHA1 Message Date
Chris Langsenkamp
5ffa4f0f2c Updated ChangeLog & DataTypes 2020-01-26 18:16:08 -05:00
shulinnn
60a2595093 Update SyncLists.md (#1445)
OP_DIRTY & OP_REMOVE are obsolete.
2020-01-21 05:00:25 -05:00
FirstGearGames
a738ca9f3a Updated video tutorial link. (#1443)
Corrected information in video tutorial with a new release. Link updated to new video.
2020-01-19 14:33:18 -05:00
Paul Pacheco
58bd292d52 Document serializing scriptable object (#1438)
* Document serializing scriptable object

* typos and grammar

* Make more readable
2020-01-19 12:10:12 +01:00
MrGadget
0a49b435cc
Added Serializable and SerializeField 2020-01-14 19:42:04 -05:00
MrGadget
f621a4aaf1
Added Serializable and SerializeField 2020-01-14 19:36:53 -05:00
MrGadget
98652e708f
Added Serializable and SerializeField 2020-01-14 19:32:39 -05:00
MrGadget
7011fade2d
Added public 2020-01-14 19:23:46 -05:00
MrGadget
503c722eb0
Added [System.Serializable] 2020-01-14 19:20:33 -05:00
vis2k
b9f52fdb46
breaking: fix: #1151 - assign SyncVars before calling the Hook. Hook now passes old and new value instead of changing it from new value to old value, as this would break all SyncVar Hook projects silently. (#1416)
* test

* new docs

* adjust CheckForHookFunction to expect two hooks

* update example

* update example

* update example

* update test

* update example

* SyncVar.set: store value in oldValue variable

* SyncVar.set: pass old value to hook too

* TODO

* SyncVar deserialize store value in oldValue variable (for simple types)

* SyncVar deserialize: pass old value to hook too (for simple types)

* add test for GameObject type

* fix comment

* SyncVar deserialize: set value before calling hook

* add TODO

* SyncVar.set: set value before calling hook

* replace tests

* GO test

* SyncVar deserialize: move oldvalue code higher up so it applies to GO/NI too

* syntax

* SyncVar deserialize: pass oldValue to hook (GO/NI types)

* SyncVar deserialize: set netid before calling hook (GO/NI types)

* update comment

* update comment

* update comment

* shorter

* comment, TODO

* put oldValue code into separate cases again

* fix SyncVarEqual comparing the same two __goNetId values

* get rid of tmpValue

* fix weaver tests

* remove TODO

* SyncVar deserialize simple types: get rid of tmpValue here too

* remove tests
2020-01-10 16:17:13 +01:00
Chris Langsenkamp
379e4c38cc Updated Dev Server docs and TOC 2020-01-06 04:23:57 -05:00
FirstGearGames
b31f885421
- Added video tutorials for built-in data types and custom data types.
- Added video tutorials for built-in data types and custom data types.
2020-01-03 12:06:32 -05:00
Paul Pacheco
c3ffb50722
docs: explain limitations a little better 2019-12-30 12:15:32 -06:00
Chris Langsenkamp
952855ef64 Restore Overview entries in TOC's 2019-12-30 04:35:18 -05:00
Icezman001
11b5a6639e Update index.md (#1367)
Forgot a %20 in the last picture. it didn't show. Is fixed
2019-12-29 13:21:21 -06:00
Icezman001
9421696447 Update toc.yml (#1366)
Stop showing overview on the left. It's the same as the title so doesn't need to be shown
2019-12-29 13:02:03 -06:00
Icezman001
19321d575f docs: Explain how to set a server in AWS (#1365)
* Create DevelopmentServer.md

This guide focuses on helping people try out their projects on a dedicated server so a more realistic test can be performed to see if everything works correctly.
This focuses on the free/trial aspect from the chosen providers and tries to make it very clear to readers that "free" is relative and Mirror can not be held responsible if they go above the providers limits.
It is mainly a guide on setting up the dedicated server through different providers to test your Mirror project.

Question:
Should I put it all under each other or should each provider/possibility be a different page like synchronization/GameObjects?
For example:
Overview
AWS
Azure
Google

* Make dedicated servers a submenu

* Add files via upload

* Move AWS inside it's own folder

* Update index.md

Changed the imgur links to the github images in the AWS folder so offline access is possible

* Update index.md

As suggestion from SoftwareGuy from suggestion: https://github.com/vis2k/Mirror/pull/1365#discussion_r361819820
I have made this in a bullet point so it's more clearly visible

* Update index.md

* Update index.md

* Update index.md

Added the changes as SoftwareGuy mentioned

* Update index.md

Another update to the formatting.
Changed some parts to titles so it's easier to navigate through the right hand side on github pages.
Some more formatting done

* Update index.md

Changed the titles from the 7 steps to include the step number for easier following

* Update index.md

Forgot this one: https://github.com/vis2k/Mirror/pull/1365#discussion_r361819874

Co-authored-by: Paul Pacheco <paulpach@gmail.com>
2019-12-29 11:44:26 -06:00
Icezman001
ad7e7e58a3 Update Profiler.md (#1364)
Changed patreon mentions to github supporter mentions
2019-12-28 16:56:21 +01:00
Chris Langsenkamp
7a138b9926 Updated NetworkBehaviour doc 2019-12-22 17:30:14 -05:00
Paul Pacheco
68a004a63b
improve authentication doc
just make text a little easier to read
2019-12-22 10:26:23 -06:00
FirstGearGames
62050666b9
Added video tutorial link. 2019-12-22 08:54:04 -05:00
rxmarccall
5658b0695d
Update NetworkBehaviour.md
Simple typo for `ClientRPC` attribute that should be `ClientRpc`
2019-12-20 15:42:16 -07:00
MrGadget
c51b8c7508
Merge pull request #1320 from rxmarccall/patch-1
Update SceneObjects.md
2019-12-19 10:18:18 -05:00
Icezman001
a21ab8934b
Update SyncVarHook.md
In the example while reading the guides it just seemed easier to put the variables at the top (as you read the OnStartServer method you see a variable and try to find what it is, but it's further down.
Easier to understand in my mind. Not sure if it's a huge issue for others
2019-12-19 15:54:35 +01:00
MrGadget
f521f1b06e
Update Conversion.md 2019-12-19 09:41:58 -05:00
rxmarccall
e49456da5f
Update doc/Guides/GameObjects/SceneObjects.md
Looks great!

Co-Authored-By: MrGadget <chris@clevertech.net>
2019-12-18 17:10:28 -07:00
rxmarccall
11df4dd2f8
Update SceneObjects.md
Clarification that networked scene objects will not enable until an actual Player Object has been created
2019-12-18 15:46:31 -07:00
MrGadget
2b5370f129
Merge pull request #1311 from FirstGearGames/patch-5
Added missing field setter on Item ReadItem() for ARMOR.
2019-12-16 17:31:21 -05:00
MrGadget
16fe7d3643
Merge pull request #1312 from FirstGearGames/patch-6
Added video tutorial.
2019-12-16 17:30:57 -05:00
MrGadget
f09b06584e
Merge pull request #1313 from FirstGearGames/patch-7
Changedvideo link to video within playlist.
2019-12-16 17:30:43 -05:00
FirstGearGames
beca3dfd20
Added SyncVar hook video link. 2019-12-16 16:51:53 -05:00
FirstGearGames
0cabfff9c8
Changedvideo link to video within playlist. 2019-12-16 16:49:34 -05:00
FirstGearGames
c51b27eb2f
Added video tutorial. 2019-12-16 16:48:10 -05:00
FirstGearGames
3cb4f93790
Added missing field setter on Item ReadItem() for ARMOR. 2019-12-16 15:33:12 -05:00
MrGadget
3b1e6dcc6f
Update SpawnPlayerCustom.md 2019-12-15 18:56:38 -05:00
Paul Pacheco
3e1d0bd147 doc: Improved alt for video tutorial 2019-12-14 14:16:07 -06:00
Paul Pacheco
39c934af54 docs:Use video tutorial image 2019-12-14 13:50:35 -06:00
FirstGearGames
3033ed7541 docs: Added video tutorial URL (#1308)
* Update SyncVars.md

* Update doc/Guides/Sync/SyncVars.md

Co-Authored-By: Paul Pacheco <paulpach@gmail.com>

* Update SyncVars.md

- Removed starting time from video URL.

* Resize image and move to the top

* Make video bigger
2019-12-14 10:23:52 -06:00
Robin Gustafsson
a8795b3449 Fix spelling mistakes 2019-12-07 23:31:48 +01:00
Chris Langsenkamp
05dd3b6660 Updated DataTypes doc 2019-12-04 16:07:28 -05:00
Chris Langsenkamp
9852fef846 Doc updates 2019-12-03 14:42:38 -05:00
vis2k
13e2dcccd9
breaking: SyncList.Callback passes old and new entries instead of only passing one entry which is sometimes the old, sometimes the new entry. This is more consistent and it's very useful to know the previous value in a hook for OP_SET and OP_DIRTY. (#1273)
* feature: SyncList.Callback passes old and new entries instead of only passing one entry which is sometimes the old, sometimes the new entry. This is more consistent and it's very useful to know the previous value in a hook for OP_SET and OP_DIRTY.

* update tests

* update docs
2019-12-03 08:35:41 +01:00
Paul Pacheco
706fc23127 docs: explain what sync to owner does 2019-11-28 10:20:29 -06:00
Paul Pacheco
f5e2fd49ff docs: suggest custom data types instead of overriding OnSerialize 2019-11-28 10:01:44 -06:00
Chris Langsenkamp
ca0ec5e36c Doc formatting 2019-11-27 21:48:41 -05:00
Paul Pacheco
f24c4deb74 docs: document how inheritance works with data types 2019-11-27 20:01:06 -06:00
Paul Pacheco
e02200c5fa docs: document how inheritance works with syncvars 2019-11-27 19:30:43 -06:00
gestewa
2f1458f3ff
Update index.md
Typo found in documentation, OnDeSerialize -> OnDeserialize
2019-11-24 13:59:17 -08:00
Chris Langsenkamp
6d9a12a026 Updated doc images 2019-11-23 10:58:06 +09:00
Chris Langsenkamp
2fdc224f43 update code example 2019-11-23 10:57:22 +09:00
Paul Pacheco
31ea2345cc doc: clarify ownership as seen in NetworkBehaviours 2019-11-23 10:56:34 +09:00
Chris Langsenkamp
033e7972f9 Doc Update 2019-11-23 10:53:56 +09:00
Paul Pacheco
a2f98d03b0 Improve authority docs (#1207) 2019-11-23 10:53:52 +09:00
MrGadget
2795b81e97
Moved enum 2019-11-02 01:49:46 -04:00
Paul Pacheco
d6f07cd8ac docs: it is safe to update a syncvar inside it's hook 2019-10-27 10:18:15 -05:00
vis2k
12c5a8fdc3 Revert "feat: Add Timeout to NetworkAuthenticator (#1091)"
This reverts commit e8cc9ba27b.
2019-10-20 20:12:14 +02:00
MrGadget
e8cc9ba27b feat: Add Timeout to NetworkAuthenticator (#1091)
* Add timeout to NetworkAuthenticator

* Added back the using Vis removed

* updated doc

* Typo
2019-10-20 11:23:34 -05:00
Chris Langsenkamp
9806e77718 Fixed typo 2019-10-19 23:45:52 -04:00
Chris Langsenkamp
0024353d44 Merge branch 'master' of https://github.com/vis2k/Mirror 2019-10-13 13:41:53 -04:00
Chris Langsenkamp
caa9a4db95 Updated doc code sample 2019-10-13 13:41:46 -04:00
Paul Pacheco
0466bc5c81 Update profiler screenshot for version 1.4 2019-10-13 12:07:28 -05:00
Chris Langsenkamp
bb48c50caa Merge branch 'master' of https://github.com/vis2k/Mirror 2019-10-13 12:35:00 -04:00
Chris Langsenkamp
248d042360 updated doc code sample 2019-10-13 12:34:46 -04:00
Paul Pacheco
64b7597aec Update docs for profiler version 1.3 2019-10-12 17:09:32 -05:00
MichalPetryka
2337cb2037 Data types documentatation recommends structs to be readonly and implement IEquatable. (#1138) 2019-10-06 14:45:17 -05:00
Chris Langsenkamp
c6251bc15b SyncVar Limit is 64 per NetworkBehaviour 2019-10-03 08:13:39 -04:00
Chris Langsenkamp
02f4eebfce updated code snip 2019-10-02 14:17:52 -04:00
Chris Langsenkamp
9d7960b842 updated code snip 2019-10-02 14:04:52 -04:00
Chris Langsenkamp
4306e08eb5 updated code snip 2019-10-02 13:48:58 -04:00
Paul Pacheco
07ee9ccb58 docs: move custom player docs to correct place 2019-10-01 11:27:00 -05:00
Chris Langsenkamp
3579d484b2 Updated CustomPlayer doc 2019-09-29 19:51:09 -04:00
Chris Langsenkamp
f42c852127 updated CustomPlayer 2019-09-29 17:53:49 -04:00
Chris Langsenkamp
a499febe4d Changed title 2019-09-29 16:26:47 -04:00
Paul Pacheco
32c75fe14c Describe cleaner way to add customizable character (#1090)
* Describe cleaner way to add custom characters

* Update doc/articles/Guides/CustomPlayer.md

* Update doc/articles/Guides/CustomPlayer.md

* make example code clearer

* Update doc/articles/Guides/CustomPlayer.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Guides/CustomPlayer.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Guides/CustomPlayer.md

Co-Authored-By: MrGadget <chris@clevertech.net>

* Update doc/articles/Guides/CustomPlayer.md

* Update doc/articles/Guides/CustomPlayer.md

* Apply suggestions from code review
2019-09-29 14:28:18 +02:00
Chris Langsenkamp
65551a3465 Fixed title 2019-09-28 23:43:53 -04:00
Chris Langsenkamp
8538b53dea Fixed link 2019-09-28 20:57:57 -04:00
Paul Pacheco
9096eafd2f Document profiler 2019-09-28 08:09:32 -05:00
Chris Langsenkamp
a5e2cf063b Added Profiler and cleaned up 2019-09-27 12:22:24 -04:00
Chris Langsenkamp
e71dd77f80 fixed code sample 2019-09-25 20:12:59 -04:00
Chris Langsenkamp
7c341e4e89 removed redundant bullet point 2019-09-23 00:08:41 -04:00
Chris Langsenkamp
600d11f5dd formatting 2019-09-23 00:06:36 -04:00
Chris Langsenkamp
b26ca4ad83 removed blank line 2019-09-23 00:00:49 -04:00
Chris Langsenkamp
8e8788a666 Added section about RegisterHandler 2019-09-22 23:23:11 -04:00
Chris Langsenkamp
28f30bd850 Made sentence clear 2019-09-21 10:23:00 -04:00
Chris Langsenkamp
74fd94c327 Added Authenticators section 2019-09-21 00:28:30 -04:00
Chris Langsenkamp
9c0ce5d075 Fixed TOC files 2019-09-20 23:50:38 -04:00
Chris Langsenkamp
964c88e4be Eliminated Classes section 2019-09-20 23:34:03 -04:00
Chris Langsenkamp
c8652fa347 Eliminated articles folder and moved all up to /doc 2019-09-20 22:19:58 -04:00