Skip to content

Commit 4eeae19

Browse files
Moved mod into the 000_Toolbar directory
Added method to return location of mouse at last buttonclick Added Enable method to enable/disable the button Added tooltip for stock buttons Added settings page Show tooltips Stock tooltip timeout
1 parent 5ff82c7 commit 4eeae19

File tree

18 files changed

+587
-79
lines changed

18 files changed

+587
-79
lines changed
4 KB
Binary file not shown.

ChangeLog.txt

Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,14 @@
1-
1.0.5
2-
Adoption by LGG
3-
Added Changelog
4-
Added Settings page
5-
Option to use or not Blizzy toolbar if available
6-
7-
1.0.4
8-
Switched to UICore for GUI drawing
9-
KAC alarm will be set -10 minutes before plan entry
10-
Screen message will apperar after alarm creation
11-
Fixed showAsUT config parameter not being read correctly
12-
Periapsis is shown on "Encounter" entry type
13-
Made doubles formatting a little bit saner
14-
15-
1.0.3
16-
Recompile for KSP 1.3.1
17-
18-
1.0.2
19-
Recompile for KSP 1.3.0
20-
21-
1.0.1
22-
Fixed NRE raised when Tracking Station is level 1, message will appear advicing to to upgrade it.
23-
Predict potential crash after entering celestial body atmosphere
24-
"Eat Snacks" entry type
25-
"Diving Course" entry type
26-
Plan entries time may be shown as universal and as countdown
27-
Use KSP dateTimeFormatter for date/time formatting
28-
KAC integration
29-
Updated included UIFramework to 0.2.1
30-
31-
1.0.0
32-
Initial release
1+
0.1.0
2+
Initial release
3+
4+
0.1.1
5+
Moved mod into the 000_Toolbar directory
6+
Added method to return location of mouse at last buttonclick
7+
Added Enable method to enable/disable the button
8+
Added tooltip for stock buttons
9+
Added settings page
10+
Show tooltips
11+
Stock tooltip timeout
12+
13+
TODO
14+
Add tooltip options to Blizzy
File renamed without changes.
File renamed without changes.

GameData/000_Toolbar/TC_README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# ToolbarControl
2+
3+
An interface to control both the Blizzy Toolbar and the stock Toolbar without having to code for each one.
4+
5+
// If true, activates Blizzy toolbar, if available. Otherwise, use the stock toolbar
6+
public void UseBlizzy(bool useBlizzy)
7+
8+
9+
// The TC_ClickHander is a delegate used to pass in a method reference in the AddToAllToolbars methods below
10+
public delegate void TC_ClickHandler();
11+
12+
The method AddToAllToolbars has several definitions. All parameters are the same, the only difference is that
13+
the shorter ones don't pass in unneeded parameters
14+
15+
// The position of the mouse the last time the button was clicked
16+
Vector2 buttonClickedMousePos
17+
18+
// Whether this button is currently enabled (clickable) or not.
19+
// If setting, sets enabled (clickable) or not.
20+
public bool Enabled
21+
22+
// The button's tool tip text. Set to null if no tool tip is desired.
23+
public string ToolTip
24+
25+
Definitions
26+
===========
27+
The onTrue parameter is unique in that it applies both to the stock toolbar and the Blizzy toolbar.
28+
onTrue Corresponds to the onTrue parameter in the AddModApplication function. This also corresponds to the
29+
blizzyButton.OnClick setting
30+
31+
The following corresponds to the same parameter in the AddModApplication() method
32+
onFalse
33+
onHover
34+
onHoverOut
35+
onenable
36+
onDisable
37+
38+
visibleInScenes The values are the same as stock ApplicationLauncher.AppScenes. The mod will use this to build the appropriate
39+
values for the Blizzy toolbar
40+
41+
Icons
42+
largeToolbarIcon used for the stock toolbar
43+
smallToolbarIcon Used for the Blizzy toolbar
44+
45+
If used, the following will be used to change the icon depending on whether it is active or not
46+
largeToolbarIconActive large is used for the stock toolbar
47+
largeToolbarIconInactive
48+
49+
smallToolbarIconActive small is used for Blizzy toolbar
50+
smallToolbarIconInactive
51+
52+
The following are used by the Blizzy toolbar only
53+
nameSpace Namespace of the mod
54+
toolbarId unique id for the toolbar
55+
tooltip tooltip which is shown when hovering the mouse over the button
56+
57+
58+
The following methods are available, more can be added if requested
59+
60+
61+
public void AddToAllToolbars(TC_ClickHandler onTrue, TC_ClickHandler onFalse,
62+
ApplicationLauncher.AppScenes visibleInScenes,
63+
string nameSpace, string toolbarId,
64+
string largeToolbarIcon, string smallToolbarIcon,
65+
string toolTip = "")
66+
67+
public void AddToAllToolbars(TC_ClickHandler onTrue, TC_ClickHandler onFalse,
68+
ApplicationLauncher.AppScenes visibleInScenes,
69+
string nameSpace, string toolbarId,
70+
string largeToolbarIconActive,
71+
string largeToolbarIconInactive,
72+
string smallToolbarIconActive,
73+
string smallToolbarIconInactive,
74+
string toolTip = "")
75+
76+
public void AddToAllToolbars(TC_ClickHandler onTrue, TC_ClickHandler onFalse, TC_ClickHandler onHover, TC_ClickHandler onHoverOut, TC_ClickHandler onEnable, TC_ClickHandler onDisable,
77+
ApplicationLauncher.AppScenes visibleInScenes,
78+
string nameSpace, string toolbarId,
79+
string largeToolbarIcon, string smallToolbarIcon,
80+
string toolTip = "")
81+
82+
public void AddToAllToolbars(TC_ClickHandler onTrue, TC_ClickHandler onFalse, TC_ClickHandler onHover, TC_ClickHandler onHoverOut, TC_ClickHandler onEnable, TC_ClickHandler onDisable,
83+
ApplicationLauncher.AppScenes visibleInScenes,
84+
string nameSpace, string toolbarId,
85+
string largeToolbarIconActive, string largeToolbarIconInactive, string smallToolbarIconActive, string smallToolbarIconInactive,
86+
string toolTip = "")
87+
88+
89+
If you have the toolbar selectable in a settings page, you an ensure that any time the user changes the setting
90+
the toolbar will change immediately by adding the following (example from FlightPlanner):
91+
92+
private void OnGUI()
93+
{
94+
toolbarControl.UseBlizzy(HighLogic.CurrentGame.Parameters.CustomParams<FP>().useBlizzy);
95+
}
96+
97+
You can also add, if you like, various callbacks to monitor the settings. This is a very lightweight call, if
98+
there isn't any change, it returns immediately

GameData/ToolbarControl/ToolbarControl.version renamed to GameData/000_Toolbar/ToolbarControl.version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
{
1212
"MAJOR" : 0,
1313
"MINOR" : 1,
14-
"PATCH" : 0,
14+
"PATCH" : 1,
1515
"BUILD" : 0
1616
}
1717
}

GameData/ToolbarControl/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

TC_LICENSE.md

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

0 commit comments

Comments
 (0)