Update documentation - prepare to release 4.1.0

LoogleCZ · Aug 11, 2018 · fef00d8 · fef00d8
1 parent 009e4b6
commit fef00d8
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog for Interactive Control script
 
-## 4.0.5 - Dev. version
+## 4.1.0 - Dev. version
 
 ### Added
 
@@ -14,6 +14,7 @@
 * Improvement of code in main update.
 * Fix issue #4 - saving toggle style.
 * Fix issue #5 - update error in turnOn events when retrieving status.
+* Fix issue #6 - network communication and also test this. Now MP works fine.
 
 ## 4.0.4 - 2018-01-25
 

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This is specialization for Farming Simulator 17 - Interactive Control.
 
 ## History
 
-This specialization is available many years now. In year 2014 I was asked to add monitors feature into old IC. I've done this and also started to create new concept of IC. In FS15 there was some releases, but then I've ended with scripting for FS. This was due to my graduation exams and because I went to college.
+This specialization is available many years now. In year 2014 I was asked to add monitors feature into old IC. I've done this and also started to create new concept of IC. In FS15 there was some releases, but then I've ended with scripting for FS. This was due to my graduation exams and because I went to college. Today I sometimes comes back and do some new stuff, but only sometimes.
 
 In summer 2017 GtX from LS Modcompany contacted me and asked me to revide his convert of IC to FS17. I was excited and I started to revide his code. At same time I realized that events are old and not maintained and IC should be done better. So I started to creating new version - version 4.0.0
 
@@ -24,9 +24,9 @@ Release date: 2018-01-25
 
 ### Development
 
-Last script development version: 4.0.5.
+Last script development version: 4.1.0.
 
-Last modification date: 2018-03-06
+Last modification date: 2018-08-11
 
 ## Contributors
 
@@ -36,7 +36,10 @@ Development since FS13: [Martin Fab
 
 Convert to FS17 and some changes: GtX from LS Modcompany
 
-Testing: [Ago-Systemtech (Modhoster Team)](https://www.fb.com/ago.systemtech)
+Testing:
+
+- [Ago-Systemtech (Modhoster Team)](https://www.fb.com/ago.systemtech)
+- Adam Maršík
 
 If you want to help with development with this script, you can do it here on GitHub or write me an email at [mar.fabik@gmail.com](mailto:mar.fabik@gmail.com).
 

diff --git a/documentation/en/XMLFormatDocumentation.md b/documentation/en/XMLFormatDocumentation.md
@@ -14,7 +14,7 @@ If you have any question regards this XML scheme, send me mail at [mar.fabik@gma
 
 ```xml
 <!-- IC XML schema documentation -->
-<interactiveComponents [outsideTriggerOn="false"//bool [minOutsideDistance="3"//float]]>
+<interactiveComponents [outsideTriggerOn="false"//bool [minOutsideDistance="3"//float]] [toggleStyle="1"//int]>
 	[<animations>
 		[<animation 
 			[name="modHub_error"//l10n_entry] 

diff --git a/documentation/en/components/component_multibuttons.md b/documentation/en/components/component_multibuttons.md
@@ -59,7 +59,7 @@ The following table will explain what certain attributes do:
 | **pulsingMark       | bool       | false                | If set to true, mark will be pulsing when hovering on it. |
 | pulseScale          | i3d coords | 0.01 0.01 0.01       | Tell the script how much will mark pulse. |
 | defaultStatus       | bool       | false                | Default status of component. Component's status will be set to this value when loading |
-| synch               | bool       | true                 | Tell the script if component will be synchronized via IC or not. In animations is recomended to set synch to `true` (or do not state synch attribute) |
+| synch               | bool       | true                 | Tell the script if component will be synchronized via IC or not. In multi buttons it is recomended to set synch to `false` |
 | initAction          | bool       | false                | If set to `true`, component will be triggered at loading to synchronize state and actual status. In animations is recomended to set `initAction` to `true` |
 | playClickSound      | bool       | false                | If click sound will be played when clicking the mark. |
 

diff --git a/documentation/en/components/supportedButtonEvents.md b/documentation/en/components/supportedButtonEvents.md
@@ -1,10 +1,10 @@
 # Supperted events for buttons
 
-in Interactive Control version 4.0.0. from XX.XX.2017. If you have any question or idea for new event, let me know at [mar.fabik@gmail.com](mailto:mar.fabik@gmail.com).
+in Interactive Control version 4.1.0. from 11.08.2018. If you have any question or idea for new event, let me know at [mar.fabik@gmail.com](mailto:mar.fabik@gmail.com).
 
 Please note, that some events are not tested in multiplayer yet, or I'm not sure which state use. This events have aetrisk(*) in synch attribute. If event doesn't work in MP, you could try to switch synch attribute. If event doesn't work either with synch true and false, please let me know at [mar.fabik@gmail.com](mailto:mar.fabik@gmail.com).
 
-If you're using scripts events (GearboxAddon, Cablight, etc...) buttons will be shown only if requested script is available. If script is not presented, notice is produced (in log).
+If you're using scripts events (GearboxAddon, Cablight, etc...) buttons will be shown only if requested script is available. If script is not presented, button is hidden.
 
 ## Events for steerable vehicles
 
@@ -24,7 +24,7 @@ If you're using scripts events (GearboxAddon, Cablight, etc...) buttons will be
 | steering.cruiseControl.speedUp   | `false`         | Base game           | Set speed up on cruise controll                |                                                                                                                                                       |
 | steering.cruiseControl.speedDown | `false`         | Base game           | Set speed down on cruise controll              |                                                                                                                                                       |
 | steering.lockMovingTools         | `false`         | lockMovingTools.lua | Lock Mouse control tools on vehicle            | This event is designed for use lockMovingTools.lua version 1.0 or greater                                                                             |
-| steering.handBrake               | `false`         | handBrake.lua       | Turn on/off handBrake.                         | This event needs handBrake specialization or mod installed. Since IC version 4.0.5                                                                    |
+| steering.handBrake               | `true`          | handBrake.lua       | Turn on/off handBrake.                         | This event needs handBrake specialization or mod installed. Since IC version 4.0.5                                                                    |
 
 ### Turnsignals
 
@@ -53,7 +53,6 @@ You can use `LinkToGlobalScripts` (l2gs) script with IC. All zou have to do is n
 
 Example of usage: you want to call function `l2gsToggleDC4WD` from l2gs script. Proper name in this case will be `l2gs.ToggleDC4WD`
 
-
 ## Events for controling attached inplements
 
 Please note, that front/rear attacher joint is determined by position against `Z` axis. If you will (for some reason) use different mod orientation, side recognition will not for for your mod, so you **cannot use front/rear events in your mod**

diff --git a/documentation/en/tutorials/optionalIC.md b/documentation/en/tutorials/optionalIC.md
@@ -1,6 +1,6 @@
-# How to make IC optional feature
+# How to make IC as optional feature
 
-You can also make IC optional in shop. It's not an hard task - all you need to do is follow this steps:
+You can also make IC as optional in shop. It's not an hard task - all you need to do is follow this steps:
 
 ## Step 1 - Prepare modDesc
 

diff --git a/src/icSources/InteractiveControl.lua b/src/icSources/InteractiveControl.lua
@@ -12,8 +12,8 @@
 -- GitHub project: https://github.com/LoogleCZ/FS17-InteractiveControl
 -- If anyone found errors, please contact me at mar.fabik@gmail.com or report it on GitHub
 --
--- version ID   - 4.0.5
--- version date - 2018-02-24 00:39:00
+-- version ID   - 4.1.0
+-- version date - 2018-08-11 16:30:00
 --
 
 InteractiveControl = {};

diff --git a/src/icSources/InteractiveControlEvent.lua b/src/icSources/InteractiveControlEvent.lua
@@ -1,9 +1,15 @@
---[[
-I made some quick changes here to eliminate a MP error when I did a quick check.
-I have not done a check in MP with more than one player yet. I will do this tomorrow but I wanted to make sure you were happy with the dirrection of the script :-)
-
--- OK thats OK
-]]--
+--
+-- Part of InteractiveControl script.
+-- This file contains InteractiveControlEvent class for emitting network events
+-- for IC
+--
+-- Author: Martin Fabík (LoogleCZ)
+-- Thanks Adam Maršík for network debugging
+-- For IC version: 4.1.0
+--
+-- Last edit: 2018-08-11 16:30:00
+-- Free for non-comerecial usage
+--
 
 InteractiveControlEvent = {};
 InteractiveControlEvent_mt = Class(InteractiveControlEvent, Event);

diff --git a/src/icSources/actionFunction.lua b/src/icSources/actionFunction.lua
@@ -4,10 +4,10 @@
 --
 -- Author: Martin Fabík (LoogleCZ)
 -- Author of some events: Andy (GtX)
--- For IC version: 4.0.4
+-- For IC version: 4.1.0
 -- You can find whole list of supported events in documentation
 --
--- Last edit: 2018-08-07 15:42:00
+-- Last edit: 2018-08-11 16:30:00
 -- Free for non-comerecial usage
 --
 
@@ -16,6 +16,7 @@
 -- All synch attributes in monitors should be set to TRUE.
 -- All synch attributes in visControl should be set to TRUE.
 -- All synch attributes in multi buttons should be set to FALSE.
+-- Recomended values of synch attribute for buttons can be found on GitHub 
 --
 
 --