krpc 0.2.0 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +28 -0
- data/README.md +5 -23
- data/bin/TestServer/Google.ProtocolBuffers.Serialization.dll +0 -0
- data/bin/TestServer/Google.ProtocolBuffers.dll +0 -0
- data/bin/TestServer/TestServer.exe +0 -0
- data/bin/TestServer/TestServer.xml +32 -0
- data/bin/TestServer/kRPC.dll +0 -0
- data/bin/TestServer/kRPC.xml +2208 -0
- data/krpc.gemspec +4 -2
- data/lib/krpc.rb +1 -0
- data/lib/krpc/client.rb +58 -44
- data/lib/krpc/core_extensions.rb +9 -0
- data/lib/krpc/doc.rb +5 -4
- data/lib/krpc/encoder.rb +5 -5
- data/lib/krpc/error.rb +4 -0
- data/lib/krpc/gen.rb +47 -40
- data/lib/krpc/service.rb +0 -7
- data/lib/krpc/types.rb +9 -4
- data/lib/krpc/version.rb +3 -0
- metadata +32 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bc7eede503159b08614dd86e3693e25375ab23ba
|
4
|
+
data.tar.gz: 487719509f195442deacceafd30229392fa0b309
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd08f1c6108eac5bde89c979fa64827fc6adc2c76e3e626025897872988b76ed3c3ece82d9f03580486b750c3b1e66fd849494350ade04b07d5685061ca0cdc0
|
7
|
+
data.tar.gz: fee951df3707f591ff9c970310dfa09b07cd640788af2036ad40458efb32492d6b53098df0d97fdda7bc6a9e8e7a2141d7106834fdc3d10dbf1edcbe336ddf90
|
data/.travis.yml
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
sudo: required
|
2
|
+
|
3
|
+
language: ruby
|
4
|
+
rvm:
|
5
|
+
- 2.1
|
6
|
+
- 2.2
|
7
|
+
- ruby-head
|
8
|
+
- rbx-2
|
9
|
+
|
10
|
+
matrix:
|
11
|
+
allow_failures:
|
12
|
+
- rvm: ruby-head
|
13
|
+
- rvm: rbx-2
|
14
|
+
|
15
|
+
before_install:
|
16
|
+
- sudo apt-get update -qq
|
17
|
+
- sudo apt-get install -qq mono-devel
|
18
|
+
- chmod +x bin/TestServer/TestServer.exe
|
19
|
+
|
20
|
+
script:
|
21
|
+
- bundle exec rspec --color --format documentation spec
|
22
|
+
|
23
|
+
cache:
|
24
|
+
- apt
|
25
|
+
|
26
|
+
branches:
|
27
|
+
only:
|
28
|
+
- master
|
data/README.md
CHANGED
@@ -1,8 +1,10 @@
|
|
1
|
-
kRPC-rb [![Gem Version](https://badge.fury.io/rb/krpc.svg)](http://badge.fury.io/rb/krpc)
|
1
|
+
kRPC-rb [![Gem Version](https://badge.fury.io/rb/krpc.svg)](http://badge.fury.io/rb/krpc) [![Build Status](https://travis-ci.org/TeWu/krpc-rb.svg?branch=master)](https://travis-ci.org/TeWu/krpc-rb)
|
2
2
|
=======
|
3
3
|
|
4
4
|
kRPC-rb is a Ruby client library for [kRPC](http://forum.kerbalspaceprogram.com/threads/69313), a Kerbal Space Program mod that allows you to control KSP from external scripts running outside of the game.
|
5
5
|
|
6
|
+
![kRPC-rb image](http://drive.google.com/uc?export=view&id=0B2PFP23spNJwXzFCbmR0eDF5TVE "This is kRPC-rb!")
|
7
|
+
|
6
8
|
Installation
|
7
9
|
-------
|
8
10
|
|
@@ -99,29 +101,9 @@ SpaceCenter.transform_position(
|
|
99
101
|
I recommend ending the line with `;` to suppress printing return value (the `=> nil` line at the end).
|
100
102
|
If you want doc for method whose name ends with a `=` sign, you can put `_doc` before the `=`. Alternatively use `Object#send`, like in: `client.space_center.send "active_vessel=_doc"`.
|
101
103
|
|
102
|
-
Combination of `ls`s and `_doc`s should teach you API in no time (also don't be surprised if you
|
104
|
+
Combination of `ls`s and `_doc`s should teach you API in no time (also don't be surprised if you have a lot of fun with it too :))
|
103
105
|
|
104
|
-
|
105
|
-
[31] pry(main)> sc = client.space_center;
|
106
|
-
[32] pry(main)> ls sc
|
107
|
-
...
|
108
|
-
KRPC::Services::SpaceCenter::AvailableToClassAndInstance#methods:
|
109
|
-
can_rails_warp_at clear_target draw_line launch_vessel_from_vab transform_position transform_velocity
|
110
|
-
clear_drawing draw_direction launch_vessel_from_sph transform_direction transform_rotation warp_to
|
111
|
-
KRPC::Services::SpaceCenter#methods:
|
112
|
-
active_vessel far_available physics_warp_factor rails_warp_factor= target_body= target_vessel vessels warp_rate
|
113
|
-
active_vessel= g physics_warp_factor= remote_tech_available target_docking_port target_vessel= warp_factor
|
114
|
-
bodies maximum_rails_warp_factor rails_warp_factor target_body target_docking_port= ut warp_mode
|
115
|
-
...
|
116
|
-
[33] pry(main)> sc.warp_to_doc;
|
117
|
-
SpaceCenter.warp_to(
|
118
|
-
ut :Float, - The universal time to warp to, in seconds.
|
119
|
-
max_rails_rate :Float = 100000.0, - The maximum warp rate in regular "on-rails" time warp.
|
120
|
-
max_physics_rate :Float = 2.0 - The maximum warp rate in physical time warp.
|
121
|
-
) :nil - When the time warp is complete.
|
122
|
-
|
123
|
-
Uses time acceleration to warp forward to a time in the future, specified by universal time ut. This call blocks until the desired time is reached. Uses regular "on-rails" or physical time warp as appropriate. For example, physical time warp is used when the active vessel is traveling through an atmosphere. When using regular "on-rails" time warp, the warp rate is limited by max_rails_rate, and when using physical time warp, the warp rate is limited by max_physics_rate.
|
124
|
-
```
|
106
|
+
![kRPC-rb in-REPL documentation example](http://drive.google.com/uc?export=view&id=0B2PFP23spNJwRWNIN3c2SWlpd0E "kRPC-rb in-REPL documentation example")
|
125
107
|
|
126
108
|
Streaming
|
127
109
|
-------
|
Binary file
|
Binary file
|
Binary file
|
@@ -0,0 +1,32 @@
|
|
1
|
+
<?xml version="1.0"?>
|
2
|
+
<doc>
|
3
|
+
<assembly>
|
4
|
+
<name>TestServer</name>
|
5
|
+
</assembly>
|
6
|
+
<members>
|
7
|
+
<member name="T:TestServer.Services.TestService">
|
8
|
+
<summary>
|
9
|
+
Service documentation string.
|
10
|
+
</summary></member>
|
11
|
+
<member name="M:TestServer.Services.TestService.FloatToString(System.Single)">
|
12
|
+
<summary>
|
13
|
+
Procedure documentation string.
|
14
|
+
</summary></member>
|
15
|
+
<member name="P:TestServer.Services.TestService.StringProperty">
|
16
|
+
<summary>
|
17
|
+
Property documentation string.
|
18
|
+
</summary></member>
|
19
|
+
<member name="T:TestServer.Services.TestService.TestClass">
|
20
|
+
<summary>
|
21
|
+
Class documentation string.
|
22
|
+
</summary></member>
|
23
|
+
<member name="M:TestServer.Services.TestService.TestClass.GetValue">
|
24
|
+
<summary>
|
25
|
+
Method documentation string.
|
26
|
+
</summary></member>
|
27
|
+
<member name="P:TestServer.Services.TestService.TestClass.IntProperty">
|
28
|
+
<summary>
|
29
|
+
Property documentation string.
|
30
|
+
</summary></member>
|
31
|
+
</members>
|
32
|
+
</doc>
|
Binary file
|
@@ -0,0 +1,2208 @@
|
|
1
|
+
<?xml version="1.0"?>
|
2
|
+
<doc>
|
3
|
+
<assembly>
|
4
|
+
<name>kRPC</name>
|
5
|
+
</assembly>
|
6
|
+
<members>
|
7
|
+
<member name="T:KRPC.CompatibilityChecker">
|
8
|
+
* This utility displays a warning with a list of mods that determine themselves
|
9
|
+
* to be incompatible with the current running version of Kerbal Space Program.
|
10
|
+
*
|
11
|
+
* See this forum thread for details:
|
12
|
+
* http://forum.kerbalspaceprogram.com/threads/65395-Voluntarily-Locking-Plugins-to-a-Particular-KSP-Version</member>
|
13
|
+
<member name="T:KRPC.Continuations.Continuation`1">
|
14
|
+
<summary>
|
15
|
+
A continuation that returns a result of type T
|
16
|
+
</summary></member>
|
17
|
+
<member name="M:KRPC.Continuations.Continuation`1.Run">
|
18
|
+
<summary>
|
19
|
+
Run the continuation and return the result.
|
20
|
+
</summary></member>
|
21
|
+
<member name="M:KRPC.Continuations.Continuation`1.RunUntyped">
|
22
|
+
<summary>
|
23
|
+
Run the continuation and return the result.
|
24
|
+
</summary></member>
|
25
|
+
<member name="T:KRPC.Continuations.Continuation">
|
26
|
+
<summary>
|
27
|
+
A continuation that does not return a value
|
28
|
+
</summary></member>
|
29
|
+
<member name="M:KRPC.Continuations.Continuation.Run">
|
30
|
+
<summary>
|
31
|
+
Run the continuation and return the result.
|
32
|
+
</summary></member>
|
33
|
+
<member name="M:KRPC.Continuations.Continuation.RunUntyped">
|
34
|
+
<summary>
|
35
|
+
Run the continuation and return the result.
|
36
|
+
</summary></member>
|
37
|
+
<member name="T:KRPC.Continuations.IContinuation">
|
38
|
+
<summary>
|
39
|
+
A continuation
|
40
|
+
</summary></member>
|
41
|
+
<member name="M:KRPC.Continuations.IContinuation.RunUntyped">
|
42
|
+
<summary>
|
43
|
+
Run the continuation and return the result.
|
44
|
+
</summary></member>
|
45
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`1">
|
46
|
+
<summary>
|
47
|
+
A continuation wrapping a function that takes 0 arguments and returns a result.
|
48
|
+
</summary></member>
|
49
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`1.Fn">
|
50
|
+
<summary>
|
51
|
+
Delegate used to invoke the continuation.
|
52
|
+
</summary></member>
|
53
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`1.#ctor(KRPC.Continuations.ParameterizedContinuation{`0}.Fn)">
|
54
|
+
<summary>
|
55
|
+
Create a continuation from a delegate and its arguments.
|
56
|
+
</summary></member>
|
57
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`1.Run">
|
58
|
+
<summary>
|
59
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
60
|
+
</summary></member>
|
61
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid">
|
62
|
+
<summary>
|
63
|
+
A continuation wrapping a function that takes 0 arguments, but does not return a result.
|
64
|
+
</summary></member>
|
65
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid.Fn">
|
66
|
+
<summary>
|
67
|
+
Delegate used to invoke the continuation.
|
68
|
+
</summary></member>
|
69
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid.#ctor(KRPC.Continuations.ParameterizedContinuationVoid.Fn)">
|
70
|
+
<summary>
|
71
|
+
Create a continuation from a delegate and its arguments.
|
72
|
+
</summary></member>
|
73
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid.Run">
|
74
|
+
<summary>
|
75
|
+
Invoke the continuation delegate with the stored arguments.
|
76
|
+
</summary></member>
|
77
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`2">
|
78
|
+
<summary>
|
79
|
+
A continuation wrapping a function that takes 1 arguments and returns a result.
|
80
|
+
</summary></member>
|
81
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`2.Fn">
|
82
|
+
<summary>
|
83
|
+
Delegate used to invoke the continuation.
|
84
|
+
</summary></member>
|
85
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`2.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1}.Fn,`1)">
|
86
|
+
<summary>
|
87
|
+
Create a continuation from a delegate and its arguments.
|
88
|
+
</summary></member>
|
89
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`2.Run">
|
90
|
+
<summary>
|
91
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
92
|
+
</summary></member>
|
93
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`1">
|
94
|
+
<summary>
|
95
|
+
A continuation wrapping a function that takes 1 arguments, but does not return a result.
|
96
|
+
</summary></member>
|
97
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`1.Fn">
|
98
|
+
<summary>
|
99
|
+
Delegate used to invoke the continuation.
|
100
|
+
</summary></member>
|
101
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`1.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0}.Fn,`0)">
|
102
|
+
<summary>
|
103
|
+
Create a continuation from a delegate and its arguments.
|
104
|
+
</summary></member>
|
105
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`1.Run">
|
106
|
+
<summary>
|
107
|
+
Invoke the continuation delegate with the stored arguments.
|
108
|
+
</summary></member>
|
109
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`3">
|
110
|
+
<summary>
|
111
|
+
A continuation wrapping a function that takes 2 arguments and returns a result.
|
112
|
+
</summary></member>
|
113
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`3.Fn">
|
114
|
+
<summary>
|
115
|
+
Delegate used to invoke the continuation.
|
116
|
+
</summary></member>
|
117
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`3.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2}.Fn,`1,`2)">
|
118
|
+
<summary>
|
119
|
+
Create a continuation from a delegate and its arguments.
|
120
|
+
</summary></member>
|
121
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`3.Run">
|
122
|
+
<summary>
|
123
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
124
|
+
</summary></member>
|
125
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`2">
|
126
|
+
<summary>
|
127
|
+
A continuation wrapping a function that takes 2 arguments, but does not return a result.
|
128
|
+
</summary></member>
|
129
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`2.Fn">
|
130
|
+
<summary>
|
131
|
+
Delegate used to invoke the continuation.
|
132
|
+
</summary></member>
|
133
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`2.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1}.Fn,`0,`1)">
|
134
|
+
<summary>
|
135
|
+
Create a continuation from a delegate and its arguments.
|
136
|
+
</summary></member>
|
137
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`2.Run">
|
138
|
+
<summary>
|
139
|
+
Invoke the continuation delegate with the stored arguments.
|
140
|
+
</summary></member>
|
141
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`4">
|
142
|
+
<summary>
|
143
|
+
A continuation wrapping a function that takes 3 arguments and returns a result.
|
144
|
+
</summary></member>
|
145
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`4.Fn">
|
146
|
+
<summary>
|
147
|
+
Delegate used to invoke the continuation.
|
148
|
+
</summary></member>
|
149
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`4.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3}.Fn,`1,`2,`3)">
|
150
|
+
<summary>
|
151
|
+
Create a continuation from a delegate and its arguments.
|
152
|
+
</summary></member>
|
153
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`4.Run">
|
154
|
+
<summary>
|
155
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
156
|
+
</summary></member>
|
157
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`3">
|
158
|
+
<summary>
|
159
|
+
A continuation wrapping a function that takes 3 arguments, but does not return a result.
|
160
|
+
</summary></member>
|
161
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`3.Fn">
|
162
|
+
<summary>
|
163
|
+
Delegate used to invoke the continuation.
|
164
|
+
</summary></member>
|
165
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`3.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2}.Fn,`0,`1,`2)">
|
166
|
+
<summary>
|
167
|
+
Create a continuation from a delegate and its arguments.
|
168
|
+
</summary></member>
|
169
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`3.Run">
|
170
|
+
<summary>
|
171
|
+
Invoke the continuation delegate with the stored arguments.
|
172
|
+
</summary></member>
|
173
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`5">
|
174
|
+
<summary>
|
175
|
+
A continuation wrapping a function that takes 4 arguments and returns a result.
|
176
|
+
</summary></member>
|
177
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`5.Fn">
|
178
|
+
<summary>
|
179
|
+
Delegate used to invoke the continuation.
|
180
|
+
</summary></member>
|
181
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`5.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4}.Fn,`1,`2,`3,`4)">
|
182
|
+
<summary>
|
183
|
+
Create a continuation from a delegate and its arguments.
|
184
|
+
</summary></member>
|
185
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`5.Run">
|
186
|
+
<summary>
|
187
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
188
|
+
</summary></member>
|
189
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`4">
|
190
|
+
<summary>
|
191
|
+
A continuation wrapping a function that takes 4 arguments, but does not return a result.
|
192
|
+
</summary></member>
|
193
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`4.Fn">
|
194
|
+
<summary>
|
195
|
+
Delegate used to invoke the continuation.
|
196
|
+
</summary></member>
|
197
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`4.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3}.Fn,`0,`1,`2,`3)">
|
198
|
+
<summary>
|
199
|
+
Create a continuation from a delegate and its arguments.
|
200
|
+
</summary></member>
|
201
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`4.Run">
|
202
|
+
<summary>
|
203
|
+
Invoke the continuation delegate with the stored arguments.
|
204
|
+
</summary></member>
|
205
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`6">
|
206
|
+
<summary>
|
207
|
+
A continuation wrapping a function that takes 5 arguments and returns a result.
|
208
|
+
</summary></member>
|
209
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`6.Fn">
|
210
|
+
<summary>
|
211
|
+
Delegate used to invoke the continuation.
|
212
|
+
</summary></member>
|
213
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`6.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4,`5}.Fn,`1,`2,`3,`4,`5)">
|
214
|
+
<summary>
|
215
|
+
Create a continuation from a delegate and its arguments.
|
216
|
+
</summary></member>
|
217
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`6.Run">
|
218
|
+
<summary>
|
219
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
220
|
+
</summary></member>
|
221
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`5">
|
222
|
+
<summary>
|
223
|
+
A continuation wrapping a function that takes 5 arguments, but does not return a result.
|
224
|
+
</summary></member>
|
225
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`5.Fn">
|
226
|
+
<summary>
|
227
|
+
Delegate used to invoke the continuation.
|
228
|
+
</summary></member>
|
229
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`5.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3,`4}.Fn,`0,`1,`2,`3,`4)">
|
230
|
+
<summary>
|
231
|
+
Create a continuation from a delegate and its arguments.
|
232
|
+
</summary></member>
|
233
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`5.Run">
|
234
|
+
<summary>
|
235
|
+
Invoke the continuation delegate with the stored arguments.
|
236
|
+
</summary></member>
|
237
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`7">
|
238
|
+
<summary>
|
239
|
+
A continuation wrapping a function that takes 6 arguments and returns a result.
|
240
|
+
</summary></member>
|
241
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`7.Fn">
|
242
|
+
<summary>
|
243
|
+
Delegate used to invoke the continuation.
|
244
|
+
</summary></member>
|
245
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`7.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4,`5,`6}.Fn,`1,`2,`3,`4,`5,`6)">
|
246
|
+
<summary>
|
247
|
+
Create a continuation from a delegate and its arguments.
|
248
|
+
</summary></member>
|
249
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`7.Run">
|
250
|
+
<summary>
|
251
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
252
|
+
</summary></member>
|
253
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`6">
|
254
|
+
<summary>
|
255
|
+
A continuation wrapping a function that takes 6 arguments, but does not return a result.
|
256
|
+
</summary></member>
|
257
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`6.Fn">
|
258
|
+
<summary>
|
259
|
+
Delegate used to invoke the continuation.
|
260
|
+
</summary></member>
|
261
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`6.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3,`4,`5}.Fn,`0,`1,`2,`3,`4,`5)">
|
262
|
+
<summary>
|
263
|
+
Create a continuation from a delegate and its arguments.
|
264
|
+
</summary></member>
|
265
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`6.Run">
|
266
|
+
<summary>
|
267
|
+
Invoke the continuation delegate with the stored arguments.
|
268
|
+
</summary></member>
|
269
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`8">
|
270
|
+
<summary>
|
271
|
+
A continuation wrapping a function that takes 7 arguments and returns a result.
|
272
|
+
</summary></member>
|
273
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`8.Fn">
|
274
|
+
<summary>
|
275
|
+
Delegate used to invoke the continuation.
|
276
|
+
</summary></member>
|
277
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`8.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4,`5,`6,`7}.Fn,`1,`2,`3,`4,`5,`6,`7)">
|
278
|
+
<summary>
|
279
|
+
Create a continuation from a delegate and its arguments.
|
280
|
+
</summary></member>
|
281
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`8.Run">
|
282
|
+
<summary>
|
283
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
284
|
+
</summary></member>
|
285
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`7">
|
286
|
+
<summary>
|
287
|
+
A continuation wrapping a function that takes 7 arguments, but does not return a result.
|
288
|
+
</summary></member>
|
289
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`7.Fn">
|
290
|
+
<summary>
|
291
|
+
Delegate used to invoke the continuation.
|
292
|
+
</summary></member>
|
293
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`7.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3,`4,`5,`6}.Fn,`0,`1,`2,`3,`4,`5,`6)">
|
294
|
+
<summary>
|
295
|
+
Create a continuation from a delegate and its arguments.
|
296
|
+
</summary></member>
|
297
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`7.Run">
|
298
|
+
<summary>
|
299
|
+
Invoke the continuation delegate with the stored arguments.
|
300
|
+
</summary></member>
|
301
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`9">
|
302
|
+
<summary>
|
303
|
+
A continuation wrapping a function that takes 8 arguments and returns a result.
|
304
|
+
</summary></member>
|
305
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`9.Fn">
|
306
|
+
<summary>
|
307
|
+
Delegate used to invoke the continuation.
|
308
|
+
</summary></member>
|
309
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`9.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4,`5,`6,`7,`8}.Fn,`1,`2,`3,`4,`5,`6,`7,`8)">
|
310
|
+
<summary>
|
311
|
+
Create a continuation from a delegate and its arguments.
|
312
|
+
</summary></member>
|
313
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`9.Run">
|
314
|
+
<summary>
|
315
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
316
|
+
</summary></member>
|
317
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`8">
|
318
|
+
<summary>
|
319
|
+
A continuation wrapping a function that takes 8 arguments, but does not return a result.
|
320
|
+
</summary></member>
|
321
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`8.Fn">
|
322
|
+
<summary>
|
323
|
+
Delegate used to invoke the continuation.
|
324
|
+
</summary></member>
|
325
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`8.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3,`4,`5,`6,`7}.Fn,`0,`1,`2,`3,`4,`5,`6,`7)">
|
326
|
+
<summary>
|
327
|
+
Create a continuation from a delegate and its arguments.
|
328
|
+
</summary></member>
|
329
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`8.Run">
|
330
|
+
<summary>
|
331
|
+
Invoke the continuation delegate with the stored arguments.
|
332
|
+
</summary></member>
|
333
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`10">
|
334
|
+
<summary>
|
335
|
+
A continuation wrapping a function that takes 9 arguments and returns a result.
|
336
|
+
</summary></member>
|
337
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`10.Fn">
|
338
|
+
<summary>
|
339
|
+
Delegate used to invoke the continuation.
|
340
|
+
</summary></member>
|
341
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`10.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4,`5,`6,`7,`8,`9}.Fn,`1,`2,`3,`4,`5,`6,`7,`8,`9)">
|
342
|
+
<summary>
|
343
|
+
Create a continuation from a delegate and its arguments.
|
344
|
+
</summary></member>
|
345
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`10.Run">
|
346
|
+
<summary>
|
347
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
348
|
+
</summary></member>
|
349
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`9">
|
350
|
+
<summary>
|
351
|
+
A continuation wrapping a function that takes 9 arguments, but does not return a result.
|
352
|
+
</summary></member>
|
353
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`9.Fn">
|
354
|
+
<summary>
|
355
|
+
Delegate used to invoke the continuation.
|
356
|
+
</summary></member>
|
357
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`9.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3,`4,`5,`6,`7,`8}.Fn,`0,`1,`2,`3,`4,`5,`6,`7,`8)">
|
358
|
+
<summary>
|
359
|
+
Create a continuation from a delegate and its arguments.
|
360
|
+
</summary></member>
|
361
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`9.Run">
|
362
|
+
<summary>
|
363
|
+
Invoke the continuation delegate with the stored arguments.
|
364
|
+
</summary></member>
|
365
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`11">
|
366
|
+
<summary>
|
367
|
+
A continuation wrapping a function that takes 10 arguments and returns a result.
|
368
|
+
</summary></member>
|
369
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuation`11.Fn">
|
370
|
+
<summary>
|
371
|
+
Delegate used to invoke the continuation.
|
372
|
+
</summary></member>
|
373
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`11.#ctor(KRPC.Continuations.ParameterizedContinuation{`0,`1,`2,`3,`4,`5,`6,`7,`8,`9,`10}.Fn,`1,`2,`3,`4,`5,`6,`7,`8,`9,`10)">
|
374
|
+
<summary>
|
375
|
+
Create a continuation from a delegate and its arguments.
|
376
|
+
</summary></member>
|
377
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuation`11.Run">
|
378
|
+
<summary>
|
379
|
+
Invoke the continuation delegate with the stored arguments, and return the result.
|
380
|
+
</summary></member>
|
381
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`10">
|
382
|
+
<summary>
|
383
|
+
A continuation wrapping a function that takes 10 arguments, but does not return a result.
|
384
|
+
</summary></member>
|
385
|
+
<member name="T:KRPC.Continuations.ParameterizedContinuationVoid`10.Fn">
|
386
|
+
<summary>
|
387
|
+
Delegate used to invoke the continuation.
|
388
|
+
</summary></member>
|
389
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`10.#ctor(KRPC.Continuations.ParameterizedContinuationVoid{`0,`1,`2,`3,`4,`5,`6,`7,`8,`9}.Fn,`0,`1,`2,`3,`4,`5,`6,`7,`8,`9)">
|
390
|
+
<summary>
|
391
|
+
Create a continuation from a delegate and its arguments.
|
392
|
+
</summary></member>
|
393
|
+
<member name="M:KRPC.Continuations.ParameterizedContinuationVoid`10.Run">
|
394
|
+
<summary>
|
395
|
+
Invoke the continuation delegate with the stored arguments.
|
396
|
+
</summary></member>
|
397
|
+
<member name="T:KRPC.Continuations.YieldException">
|
398
|
+
<summary>
|
399
|
+
Thrown by a continuation to indicate that there is more work to do later,
|
400
|
+
represented by the new continuation in the exception.
|
401
|
+
</summary></member>
|
402
|
+
<member name="P:KRPC.Continuations.YieldException.Continuation">
|
403
|
+
<summary>
|
404
|
+
The continuation to run to continue the work.
|
405
|
+
</summary></member>
|
406
|
+
<member name="M:KRPC.Continuations.YieldException.#ctor(KRPC.Continuations.IContinuation)">
|
407
|
+
<summary>
|
408
|
+
Create a yield exception, with a continuation
|
409
|
+
representing the work to do later.
|
410
|
+
</summary></member>
|
411
|
+
<member name="T:KRPC.KRPCAddon">
|
412
|
+
<summary>
|
413
|
+
Main KRPC addon. Contains the server instance and UI.
|
414
|
+
</summary></member>
|
415
|
+
<member name="M:KRPC.KRPCAddon.Finalize">
|
416
|
+
<summary>
|
417
|
+
Destructor. Stops the server if running.
|
418
|
+
</summary></member>
|
419
|
+
<member name="M:KRPC.KRPCAddon.Awake">
|
420
|
+
<summary>
|
421
|
+
Wake the addon. Creates the server instance and UI.
|
422
|
+
</summary></member>
|
423
|
+
<member name="M:KRPC.KRPCAddon.OnDestroy">
|
424
|
+
<summary>
|
425
|
+
Destroy the UI.
|
426
|
+
</summary></member>
|
427
|
+
<member name="M:KRPC.KRPCAddon.FixedUpdate">
|
428
|
+
<summary>
|
429
|
+
Trigger server update
|
430
|
+
</summary></member>
|
431
|
+
<member name="T:KRPC.KRPCServer">
|
432
|
+
<summary>
|
433
|
+
The kRPC server
|
434
|
+
</summary></member>
|
435
|
+
<member name="E:KRPC.KRPCServer.OnStarted">
|
436
|
+
<summary>
|
437
|
+
Event triggered when the server starts
|
438
|
+
</summary></member>
|
439
|
+
<member name="E:KRPC.KRPCServer.OnStopped">
|
440
|
+
<summary>
|
441
|
+
Event triggered when the server stops
|
442
|
+
</summary></member>
|
443
|
+
<member name="E:KRPC.KRPCServer.OnClientRequestingConnection">
|
444
|
+
<summary>
|
445
|
+
Event triggered when a client is requesting a connection
|
446
|
+
</summary></member>
|
447
|
+
<member name="E:KRPC.KRPCServer.OnClientConnected">
|
448
|
+
<summary>
|
449
|
+
Event triggered when a client has connected
|
450
|
+
</summary></member>
|
451
|
+
<member name="E:KRPC.KRPCServer.OnClientActivity">
|
452
|
+
<summary>
|
453
|
+
Event triggered when a client performs some activity
|
454
|
+
</summary></member>
|
455
|
+
<member name="E:KRPC.KRPCServer.OnClientDisconnected">
|
456
|
+
<summary>
|
457
|
+
Event triggered when a client has disconnected
|
458
|
+
</summary></member>
|
459
|
+
<member name="T:KRPC.KRPCServer.Context">
|
460
|
+
<summary>
|
461
|
+
Stores the context in which a continuation is executed.
|
462
|
+
For example, used by a continuation to find out which client made the request.
|
463
|
+
</summary></member>
|
464
|
+
<member name="P:KRPC.KRPCServer.Context.Server">
|
465
|
+
<summary>
|
466
|
+
The server instance
|
467
|
+
</summary></member>
|
468
|
+
<member name="P:KRPC.KRPCServer.Context.RPCClient">
|
469
|
+
<summary>
|
470
|
+
The current client
|
471
|
+
</summary></member>
|
472
|
+
<member name="P:KRPC.KRPCServer.Context.GameScene">
|
473
|
+
<summary>
|
474
|
+
The current game scene
|
475
|
+
</summary></member>
|
476
|
+
<member name="M:KRPC.KRPCServer.Start">
|
477
|
+
<summary>
|
478
|
+
Start the server
|
479
|
+
</summary></member>
|
480
|
+
<member name="M:KRPC.KRPCServer.Stop">
|
481
|
+
<summary>
|
482
|
+
Stop the server
|
483
|
+
</summary></member>
|
484
|
+
<member name="P:KRPC.KRPCServer.Address">
|
485
|
+
<summary>
|
486
|
+
Get/set the servers listen address
|
487
|
+
</summary></member>
|
488
|
+
<member name="P:KRPC.KRPCServer.RPCPort">
|
489
|
+
<summary>
|
490
|
+
Get/set the RPC port
|
491
|
+
</summary></member>
|
492
|
+
<member name="P:KRPC.KRPCServer.StreamPort">
|
493
|
+
<summary>
|
494
|
+
Get/set the Stream port
|
495
|
+
</summary></member>
|
496
|
+
<member name="P:KRPC.KRPCServer.OneRPCPerUpdate">
|
497
|
+
<summary>
|
498
|
+
Only execute one RPC for each client per update.
|
499
|
+
</summary></member>
|
500
|
+
<member name="P:KRPC.KRPCServer.MaxTimePerUpdate">
|
501
|
+
<summary>
|
502
|
+
Get/set the maximum number of microseconds to spend in a call to FixedUpdate
|
503
|
+
</summary></member>
|
504
|
+
<member name="P:KRPC.KRPCServer.AdaptiveRateControl">
|
505
|
+
<summary>
|
506
|
+
Get/set whether MaxTimePerUpdate should be adjusted to achieve a target framerate.
|
507
|
+
</summary></member>
|
508
|
+
<member name="P:KRPC.KRPCServer.BlockingRecv">
|
509
|
+
<summary>
|
510
|
+
Get/set whether FixedUpdate should block for RecvTimeout microseconds to receive RPCs.
|
511
|
+
</summary></member>
|
512
|
+
<member name="P:KRPC.KRPCServer.RecvTimeout">
|
513
|
+
<summary>
|
514
|
+
Get/set the timeout for blocking for RPCs, in microseconds.
|
515
|
+
</summary></member>
|
516
|
+
<member name="P:KRPC.KRPCServer.Running">
|
517
|
+
<summary>
|
518
|
+
Returns true if the server is running
|
519
|
+
</summary></member>
|
520
|
+
<member name="P:KRPC.KRPCServer.Clients">
|
521
|
+
<summary>
|
522
|
+
Returns a list of clients the server knows about. Note that they might
|
523
|
+
not be connected to the server.
|
524
|
+
</summary></member>
|
525
|
+
<member name="P:KRPC.KRPCServer.BytesRead">
|
526
|
+
<summary>
|
527
|
+
Get the total number of bytes read from the network.
|
528
|
+
</summary></member>
|
529
|
+
<member name="P:KRPC.KRPCServer.BytesWritten">
|
530
|
+
<summary>
|
531
|
+
Get the total number of bytes written to the network.
|
532
|
+
</summary></member>
|
533
|
+
<member name="P:KRPC.KRPCServer.BytesReadRate">
|
534
|
+
<summary>
|
535
|
+
Get the total number of bytes read from the network.
|
536
|
+
</summary></member>
|
537
|
+
<member name="P:KRPC.KRPCServer.BytesWrittenRate">
|
538
|
+
<summary>
|
539
|
+
Get the total number of bytes written to the network.
|
540
|
+
</summary></member>
|
541
|
+
<member name="P:KRPC.KRPCServer.RPCsExecuted">
|
542
|
+
<summary>
|
543
|
+
Total number of RPCs executed.
|
544
|
+
</summary></member>
|
545
|
+
<member name="P:KRPC.KRPCServer.RPCRate">
|
546
|
+
<summary>
|
547
|
+
Number of RPCs processed per second.
|
548
|
+
</summary></member>
|
549
|
+
<member name="P:KRPC.KRPCServer.TimePerRPCUpdate">
|
550
|
+
<summary>
|
551
|
+
Time taken by the update loop per update, in seconds.
|
552
|
+
</summary></member>
|
553
|
+
<member name="P:KRPC.KRPCServer.PollTimePerRPCUpdate">
|
554
|
+
<summary>
|
555
|
+
Time taken polling for new RPCs per update, in seconds.
|
556
|
+
</summary></member>
|
557
|
+
<member name="P:KRPC.KRPCServer.ExecTimePerRPCUpdate">
|
558
|
+
<summary>
|
559
|
+
Time taken polling executing RPCs per update, in seconds.
|
560
|
+
</summary></member>
|
561
|
+
<member name="P:KRPC.KRPCServer.StreamRPCs">
|
562
|
+
<summary>
|
563
|
+
Number of currently active streaming RPCs.
|
564
|
+
</summary></member>
|
565
|
+
<member name="P:KRPC.KRPCServer.StreamRPCsExecuted">
|
566
|
+
<summary>
|
567
|
+
Total number of streaming RPCs executed.
|
568
|
+
</summary></member>
|
569
|
+
<member name="P:KRPC.KRPCServer.StreamRPCRate">
|
570
|
+
<summary>
|
571
|
+
Number of streaming RPCs processed per second.
|
572
|
+
</summary></member>
|
573
|
+
<member name="P:KRPC.KRPCServer.TimePerStreamUpdate">
|
574
|
+
<summary>
|
575
|
+
Time taken by the stream update loop, in seconds.
|
576
|
+
</summary></member>
|
577
|
+
<member name="M:KRPC.KRPCServer.Update">
|
578
|
+
<summary>
|
579
|
+
Update the server
|
580
|
+
</summary></member>
|
581
|
+
<member name="M:KRPC.KRPCServer.RPCServerUpdate">
|
582
|
+
<summary>
|
583
|
+
Update the RPC server, called once every FixedUpdate.
|
584
|
+
This method receives and executes RPCs, for up to MaxTimePerUpdate microseconds.
|
585
|
+
RPCs are delayed to the next update if this time expires. If AdaptiveRateControl
|
586
|
+
is true, MaxTimePerUpdate will be automatically adjusted to achieve a target framerate.
|
587
|
+
If NonBlockingUpdate is false, this call will block waiting for new RPCs for up to
|
588
|
+
MaxPollTimePerUpdate microseconds. If NonBlockingUpdate is true, a single non-blocking call
|
589
|
+
will be made to check for new RPCs.
|
590
|
+
</summary></member>
|
591
|
+
<member name="M:KRPC.KRPCServer.StreamServerUpdate">
|
592
|
+
<summary>
|
593
|
+
Update the Stream server. Executes all streaming RPCs and sends the results to clients.
|
594
|
+
</summary></member>
|
595
|
+
<member name="M:KRPC.KRPCServer.AddStream(KRPC.Server.IClient,KRPC.Schema.KRPC.Request)">
|
596
|
+
<summary>
|
597
|
+
Add a stream to the server
|
598
|
+
</summary></member>
|
599
|
+
<member name="M:KRPC.KRPCServer.RemoveStream(KRPC.Server.IClient,System.UInt32)">
|
600
|
+
<summary>
|
601
|
+
Remove a stream from the server
|
602
|
+
</summary></member>
|
603
|
+
<member name="M:KRPC.KRPCServer.PollRequests(System.Collections.Generic.IEnumerable{KRPC.Service.RequestContinuation})">
|
604
|
+
<summary>
|
605
|
+
Poll connected clients for new requests.
|
606
|
+
Adds a continuation to the queue for any client with a new request,
|
607
|
+
if a continuation is not already being processed for the client.
|
608
|
+
</summary></member>
|
609
|
+
<member name="M:KRPC.KRPCServer.ExecuteContinuation(KRPC.Service.RequestContinuation)">
|
610
|
+
<summary>
|
611
|
+
Execute the continuation and send a response to the client,
|
612
|
+
or throw a YieldException if the continuation is not complete.
|
613
|
+
</summary></member>
|
614
|
+
<member name="T:KRPC.Server.ClientActivityArgs">
|
615
|
+
<summary>
|
616
|
+
Arguments passed to a client activity event
|
617
|
+
</summary></member>
|
618
|
+
<member name="P:KRPC.Server.ClientActivityArgs.Client">
|
619
|
+
<summary>
|
620
|
+
The client
|
621
|
+
</summary></member>
|
622
|
+
<member name="T:KRPC.Server.ClientActivityArgs`2">
|
623
|
+
<summary>
|
624
|
+
Arguments passed to a client activity event
|
625
|
+
</summary></member>
|
626
|
+
<member name="P:KRPC.Server.ClientActivityArgs`2.Client">
|
627
|
+
<summary>
|
628
|
+
The client
|
629
|
+
</summary></member>
|
630
|
+
<member name="T:KRPC.Server.ClientConnectedArgs">
|
631
|
+
<summary>
|
632
|
+
Arguments passed to a client connected event
|
633
|
+
</summary></member>
|
634
|
+
<member name="P:KRPC.Server.ClientConnectedArgs.Client">
|
635
|
+
<summary>
|
636
|
+
The client
|
637
|
+
</summary></member>
|
638
|
+
<member name="T:KRPC.Server.ClientConnectedArgs`2">
|
639
|
+
<summary>
|
640
|
+
Arguments passed to a client connected event
|
641
|
+
</summary></member>
|
642
|
+
<member name="P:KRPC.Server.ClientConnectedArgs`2.Client">
|
643
|
+
<summary>
|
644
|
+
The client
|
645
|
+
</summary></member>
|
646
|
+
<member name="T:KRPC.Server.ClientConnectionRequest">
|
647
|
+
<summary>
|
648
|
+
Used by a client requesting connection event to determine
|
649
|
+
if the request should be allowed or denied.
|
650
|
+
</summary></member>
|
651
|
+
<member name="P:KRPC.Server.ClientConnectionRequest.ShouldAllow">
|
652
|
+
<summary>
|
653
|
+
Should the connection be allowed?
|
654
|
+
</summary></member>
|
655
|
+
<member name="P:KRPC.Server.ClientConnectionRequest.ShouldDeny">
|
656
|
+
<summary>
|
657
|
+
Should the connection be denied?
|
658
|
+
</summary></member>
|
659
|
+
<member name="P:KRPC.Server.ClientConnectionRequest.StillPending">
|
660
|
+
<summary>
|
661
|
+
Is a decision still pending?
|
662
|
+
</summary></member>
|
663
|
+
<member name="M:KRPC.Server.ClientConnectionRequest.Allow">
|
664
|
+
<summary>
|
665
|
+
Allow the connection
|
666
|
+
</summary></member>
|
667
|
+
<member name="M:KRPC.Server.ClientConnectionRequest.Deny">
|
668
|
+
<summary>
|
669
|
+
Deny the connection
|
670
|
+
</summary></member>
|
671
|
+
<member name="T:KRPC.Server.ClientDisconnectedArgs">
|
672
|
+
<summary>
|
673
|
+
Arguments passed to a client disconnected event
|
674
|
+
</summary></member>
|
675
|
+
<member name="P:KRPC.Server.ClientDisconnectedArgs.Client">
|
676
|
+
<summary>
|
677
|
+
The client
|
678
|
+
</summary></member>
|
679
|
+
<member name="T:KRPC.Server.ClientDisconnectedArgs`2">
|
680
|
+
<summary>
|
681
|
+
Arguments passed to a client disconnected event
|
682
|
+
</summary></member>
|
683
|
+
<member name="P:KRPC.Server.ClientDisconnectedArgs`2.Client">
|
684
|
+
<summary>
|
685
|
+
The client
|
686
|
+
</summary></member>
|
687
|
+
<member name="T:KRPC.Server.ClientRequestingConnectionArgs">
|
688
|
+
<summary>
|
689
|
+
Arguments passed to a client requesting connection event
|
690
|
+
</summary></member>
|
691
|
+
<member name="P:KRPC.Server.ClientRequestingConnectionArgs.Client">
|
692
|
+
<summary>
|
693
|
+
The client
|
694
|
+
</summary></member>
|
695
|
+
<member name="P:KRPC.Server.ClientRequestingConnectionArgs.Request">
|
696
|
+
<summary>
|
697
|
+
The request
|
698
|
+
</summary></member>
|
699
|
+
<member name="T:KRPC.Server.ClientRequestingConnectionArgs`2">
|
700
|
+
<summary>
|
701
|
+
Arguments passed to a client requesting connection event
|
702
|
+
</summary></member>
|
703
|
+
<member name="P:KRPC.Server.ClientRequestingConnectionArgs`2.Client">
|
704
|
+
<summary>
|
705
|
+
The client
|
706
|
+
</summary></member>
|
707
|
+
<member name="P:KRPC.Server.ClientRequestingConnectionArgs`2.Request">
|
708
|
+
<summary>
|
709
|
+
The request
|
710
|
+
</summary></member>
|
711
|
+
<member name="T:KRPC.Server.IClient">
|
712
|
+
<summary>
|
713
|
+
Non-generic client interface.
|
714
|
+
</summary></member>
|
715
|
+
<member name="P:KRPC.Server.IClient.Name">
|
716
|
+
<summary>
|
717
|
+
A string identifying the client. Should be human readable.
|
718
|
+
</summary></member>
|
719
|
+
<member name="P:KRPC.Server.IClient.Guid">
|
720
|
+
<summary>
|
721
|
+
A the globally unique identifier for the client.
|
722
|
+
</summary></member>
|
723
|
+
<member name="P:KRPC.Server.IClient.Address">
|
724
|
+
<summary>
|
725
|
+
The address of the client. Depends on the underlying communication method.
|
726
|
+
</summary>
|
727
|
+
<remarks>For example, could be an IP address when client
|
728
|
+
communication is over a network.</remarks></member>
|
729
|
+
<member name="P:KRPC.Server.IClient.Connected">
|
730
|
+
<summary>
|
731
|
+
Returns true if the client is actively connected to the server.
|
732
|
+
</summary></member>
|
733
|
+
<member name="M:KRPC.Server.IClient.Close">
|
734
|
+
<summary>
|
735
|
+
Close the connection to the client and free the connections resources.
|
736
|
+
</summary></member>
|
737
|
+
<member name="T:KRPC.Server.IClient`2">
|
738
|
+
<summary>
|
739
|
+
Generic client interface.
|
740
|
+
</summary></member>
|
741
|
+
<member name="P:KRPC.Server.IClient`2.Stream">
|
742
|
+
<summary>
|
743
|
+
A stream for communicating with the client.
|
744
|
+
</summary></member>
|
745
|
+
<member name="T:KRPC.Server.IServer">
|
746
|
+
<summary>
|
747
|
+
A non-generic server.
|
748
|
+
</summary></member>
|
749
|
+
<member name="M:KRPC.Server.IServer.Start">
|
750
|
+
<summary>
|
751
|
+
Start the server.
|
752
|
+
</summary></member>
|
753
|
+
<member name="M:KRPC.Server.IServer.Stop">
|
754
|
+
<summary>
|
755
|
+
Stop the server.
|
756
|
+
</summary></member>
|
757
|
+
<member name="M:KRPC.Server.IServer.Update">
|
758
|
+
<summary>
|
759
|
+
Update the server. Call this regularly to ensure timely handling
|
760
|
+
of new client connections and other functionality.
|
761
|
+
</summary></member>
|
762
|
+
<member name="P:KRPC.Server.IServer.Running">
|
763
|
+
<summary>
|
764
|
+
Returns true if the server is running and accepting client connections.
|
765
|
+
</summary></member>
|
766
|
+
<member name="P:KRPC.Server.IServer.Clients">
|
767
|
+
<summary>
|
768
|
+
Clients that are connected to the server.
|
769
|
+
</summary></member>
|
770
|
+
<member name="P:KRPC.Server.IServer.BytesRead">
|
771
|
+
<summary>
|
772
|
+
The total number of bytes read by the server.
|
773
|
+
</summary></member>
|
774
|
+
<member name="P:KRPC.Server.IServer.BytesWritten">
|
775
|
+
<summary>
|
776
|
+
The total number of bytes written by the server.
|
777
|
+
</summary></member>
|
778
|
+
<member name="M:KRPC.Server.IServer.ClearStats">
|
779
|
+
<summary>
|
780
|
+
Clear the bytes read and bytes written counts.
|
781
|
+
</summary></member>
|
782
|
+
<member name="T:KRPC.Server.IServer`2">
|
783
|
+
<summary>
|
784
|
+
A generic server, that receives values of type TIn from clients and
|
785
|
+
sends values of type TOut to them.
|
786
|
+
</summary></member>
|
787
|
+
<member name="M:KRPC.Server.IServer`2.Start">
|
788
|
+
<summary>
|
789
|
+
Start the server.
|
790
|
+
</summary></member>
|
791
|
+
<member name="M:KRPC.Server.IServer`2.Stop">
|
792
|
+
<summary>
|
793
|
+
Stop the server.
|
794
|
+
</summary></member>
|
795
|
+
<member name="M:KRPC.Server.IServer`2.Update">
|
796
|
+
<summary>
|
797
|
+
Update the server. Call this regularly to ensure timely handling
|
798
|
+
of new client connections and other functionality.
|
799
|
+
</summary></member>
|
800
|
+
<member name="P:KRPC.Server.IServer`2.Running">
|
801
|
+
<summary>
|
802
|
+
Returns true if the server is running and accepting client connections.
|
803
|
+
</summary></member>
|
804
|
+
<member name="P:KRPC.Server.IServer`2.Clients">
|
805
|
+
<summary>
|
806
|
+
Clients that are connected to the server.
|
807
|
+
</summary></member>
|
808
|
+
<member name="P:KRPC.Server.IServer`2.BytesRead">
|
809
|
+
<summary>
|
810
|
+
Gets the total number of bytes read from client streams.
|
811
|
+
</summary></member>
|
812
|
+
<member name="P:KRPC.Server.IServer`2.BytesWritten">
|
813
|
+
<summary>
|
814
|
+
Gets the total number of bytes written to client streams.
|
815
|
+
</summary></member>
|
816
|
+
<member name="M:KRPC.Server.IServer`2.ClearStats">
|
817
|
+
<summary>
|
818
|
+
Clear the bytes read and bytes written counts.
|
819
|
+
</summary></member>
|
820
|
+
<member name="T:KRPC.Server.IStream">
|
821
|
+
<summary>
|
822
|
+
A non-generic stream.
|
823
|
+
</summary></member>
|
824
|
+
<member name="P:KRPC.Server.IStream.DataAvailable">
|
825
|
+
<summary>
|
826
|
+
Returns true if the stream contains data to read.
|
827
|
+
</summary></member>
|
828
|
+
<member name="M:KRPC.Server.IStream.Close">
|
829
|
+
<summary>
|
830
|
+
Close the stream and free its resources.
|
831
|
+
</summary></member>
|
832
|
+
<member name="P:KRPC.Server.IStream.BytesRead">
|
833
|
+
<summary>
|
834
|
+
Gets the total number of bytes read from the stream.
|
835
|
+
</summary></member>
|
836
|
+
<member name="P:KRPC.Server.IStream.BytesWritten">
|
837
|
+
<summary>
|
838
|
+
Gets the total number of bytes written to the stream.
|
839
|
+
</summary></member>
|
840
|
+
<member name="M:KRPC.Server.IStream.ClearStats">
|
841
|
+
<summary>
|
842
|
+
Clear the bytes read and bytes written counts.
|
843
|
+
</summary></member>
|
844
|
+
<member name="T:KRPC.Server.IStream`2">
|
845
|
+
<summary>
|
846
|
+
A generic stream, from which values of type In can be read and values of type Out can be written.
|
847
|
+
</summary></member>
|
848
|
+
<member name="M:KRPC.Server.IStream`2.Read">
|
849
|
+
<summary>
|
850
|
+
Read a single value from the stream.
|
851
|
+
</summary></member>
|
852
|
+
<member name="M:KRPC.Server.IStream`2.Read(`0[],System.Int32)">
|
853
|
+
<summary>
|
854
|
+
Read multiple values from the stream, into buffer starting at offset
|
855
|
+
and up to the end of the buffer.
|
856
|
+
</summary></member>
|
857
|
+
<member name="M:KRPC.Server.IStream`2.Read(`0[],System.Int32,System.Int32)">
|
858
|
+
<summary>
|
859
|
+
Read multiple values from the stream, into buffer starting at offset
|
860
|
+
and up to the end of the buffer or size items, whichever comes first.
|
861
|
+
</summary></member>
|
862
|
+
<member name="M:KRPC.Server.IStream`2.Write(`1)">
|
863
|
+
<summary>
|
864
|
+
Write a value to the stream.
|
865
|
+
</summary></member>
|
866
|
+
<member name="M:KRPC.Server.IStream`2.Write(`1[])">
|
867
|
+
<summary>
|
868
|
+
Write multiple values to the stream.
|
869
|
+
</summary></member>
|
870
|
+
<member name="M:KRPC.Server.Net.NetworkInformation.GetLocalIPAddresses">
|
871
|
+
<summary>
|
872
|
+
Returns the IPv4 address of all local network interfaces.
|
873
|
+
</summary></member>
|
874
|
+
<member name="M:KRPC.Server.Net.NetworkInformation.GetSubnetMask(System.Net.IPAddress)">
|
875
|
+
<summary>
|
876
|
+
Returns the IPv4 subnet mask of the network interface with the given IPv4 address.
|
877
|
+
</summary></member>
|
878
|
+
<member name="E:KRPC.Server.Net.TCPServer.OnClientActivity">
|
879
|
+
<summary>
|
880
|
+
Does not trigger this event.
|
881
|
+
</summary></member>
|
882
|
+
<member name="F:KRPC.Server.Net.TCPServer.name">
|
883
|
+
<summary>
|
884
|
+
A name for the server.
|
885
|
+
</summary></member>
|
886
|
+
<member name="F:KRPC.Server.Net.TCPServer.port">
|
887
|
+
<summary>
|
888
|
+
Port that the server listens on for new connections. If set to 0,
|
889
|
+
a port number with be automatically chosen.
|
890
|
+
</summary></member>
|
891
|
+
<member name="F:KRPC.Server.Net.TCPServer.actualPort">
|
892
|
+
<summary>
|
893
|
+
The actual local port number of the server. Will be identical to
|
894
|
+
port, unless port was set to 0.
|
895
|
+
</summary></member>
|
896
|
+
<member name="F:KRPC.Server.Net.TCPServer.listenerThread">
|
897
|
+
<summary>
|
898
|
+
Thread used to poll for new connections.
|
899
|
+
</summary></member>
|
900
|
+
<member name="F:KRPC.Server.Net.TCPServer.startedEvent">
|
901
|
+
<summary>
|
902
|
+
Event used to wait for the TCP listener to start
|
903
|
+
</summary></member>
|
904
|
+
<member name="F:KRPC.Server.Net.TCPServer.running">
|
905
|
+
<summary>
|
906
|
+
True if the listenerThread is running.
|
907
|
+
</summary></member>
|
908
|
+
<member name="F:KRPC.Server.Net.TCPServer.clients">
|
909
|
+
<summary>
|
910
|
+
Connected clients.
|
911
|
+
</summary></member>
|
912
|
+
<member name="F:KRPC.Server.Net.TCPServer.pendingClients">
|
913
|
+
<summary>
|
914
|
+
Clients requesting a connection. Must be locked before accessing.
|
915
|
+
</summary></member>
|
916
|
+
<member name="M:KRPC.Server.Net.TCPServer.#ctor(System.String,System.Net.IPAddress,System.UInt16)">
|
917
|
+
<summary>
|
918
|
+
Create a TCP server. After Start() is called, the server will listen for
|
919
|
+
connections to the specified local address and port number.
|
920
|
+
</summary></member>
|
921
|
+
<member name="P:KRPC.Server.Net.TCPServer.Port">
|
922
|
+
<summary>
|
923
|
+
Port number that the server listens on. Server must be restarted for changes to take effect.
|
924
|
+
</summary></member>
|
925
|
+
<member name="P:KRPC.Server.Net.TCPServer.Address">
|
926
|
+
<summary>
|
927
|
+
Local address that the server listens on. Server must be restarted for changes to take effect.
|
928
|
+
</summary></member>
|
929
|
+
<member name="E:KRPC.Server.RPC.RPCServer.OnClientActivity">
|
930
|
+
<summary>
|
931
|
+
Does not trigger this event, unless the underlying server does.
|
932
|
+
</summary></member>
|
933
|
+
<member name="M:KRPC.Server.RPC.RPCServer.HandleClientRequestingConnection(System.Object,KRPC.Server.ClientRequestingConnectionArgs{System.Byte,System.Byte})">
|
934
|
+
<summary>
|
935
|
+
When a client requests a connection, check and parse the hello message (which should
|
936
|
+
consist of a header and a client name), then trigger RPCServer.OnClientRequestingConnection
|
937
|
+
to get response of delegates
|
938
|
+
</summary></member>
|
939
|
+
<member name="M:KRPC.Server.RPC.RPCServer.CheckHelloMessage(KRPC.Server.IClient{System.Byte,System.Byte})">
|
940
|
+
<summary>
|
941
|
+
Read the hello message (header and client name) and check that they are correct.
|
942
|
+
This is triggered whenever a client connects to the server. Returns the client name as a string,
|
943
|
+
or null if the hello message is not valid.
|
944
|
+
</summary></member>
|
945
|
+
<member name="M:KRPC.Server.RPC.RPCServer.ReadHelloMessage(KRPC.Server.IStream{System.Byte,System.Byte},System.Byte[])">
|
946
|
+
<summary>
|
947
|
+
Read a fixed length 40-byte message from the client with the given timeout
|
948
|
+
</summary></member>
|
949
|
+
<member name="M:KRPC.Server.RPC.RPCServer.CheckAndDecodeClientName(System.Byte[])">
|
950
|
+
<summary>
|
951
|
+
Validate a fixed-length 32-byte array as a UTF8 string, and return it as a string object.
|
952
|
+
</summary>
|
953
|
+
<returns>The decoded client name, or null if not valid.</returns></member>
|
954
|
+
<member name="P:KRPC.Server.RPC.RPCStream.DataAvailable">
|
955
|
+
<summary>
|
956
|
+
Returns true if there is a request waiting to be read. A Call to Read() will
|
957
|
+
not throw NoRequestException if this returns true. Throws MalformedRequestException
|
958
|
+
if a malformed request is received.
|
959
|
+
</summary></member>
|
960
|
+
<member name="M:KRPC.Server.RPC.RPCStream.Read">
|
961
|
+
<summary>
|
962
|
+
Read a request from the client. Blocks until a request is available.
|
963
|
+
Throws NoRequestException if there is no request.
|
964
|
+
Throws MalformedRequestException if malformed data is received.
|
965
|
+
</summary></member>
|
966
|
+
<member name="M:KRPC.Server.RPC.RPCStream.Write(KRPC.Schema.KRPC.Response)">
|
967
|
+
<summary>
|
968
|
+
Write a response to the client.
|
969
|
+
</summary></member>
|
970
|
+
<member name="M:KRPC.Server.RPC.RPCStream.Close">
|
971
|
+
<summary>
|
972
|
+
Close the stream.
|
973
|
+
</summary></member>
|
974
|
+
<member name="M:KRPC.Server.RPC.RPCStream.Poll">
|
975
|
+
Returns quietly if there is a message in bufferedRequest
|
976
|
+
Throws NoRequestException if not
|
977
|
+
Throws MalformedRequestException if malformed data received
|
978
|
+
Throws RequestBufferOverflowException if buffer full but complete request not received</member>
|
979
|
+
<member name="E:KRPC.Server.Stream.StreamServer.OnClientActivity">
|
980
|
+
<summary>
|
981
|
+
Does not trigger this event, unless the underlying server does.
|
982
|
+
</summary></member>
|
983
|
+
<member name="M:KRPC.Server.Stream.StreamServer.HandleClientRequestingConnection(System.Object,KRPC.Server.ClientRequestingConnectionArgs{System.Byte,System.Byte})">
|
984
|
+
<summary>
|
985
|
+
When a client requests a connection, check the hello message,
|
986
|
+
then trigger RPCServer.OnClientRequestingConnection to get response of delegates
|
987
|
+
</summary></member>
|
988
|
+
<member name="M:KRPC.Server.Stream.StreamServer.CheckHelloMessage(KRPC.Server.IClient{System.Byte,System.Byte})">
|
989
|
+
<summary>
|
990
|
+
Read hello message from client, and client identifier and check they are correct.
|
991
|
+
This is triggered whenever a client connects to the server.
|
992
|
+
Returns the guid of the client, or Guid.Empty if the hello message and client identifier are valid.
|
993
|
+
</summary></member>
|
994
|
+
<member name="M:KRPC.Server.Stream.StreamServer.ReadHelloMessage(KRPC.Server.IStream{System.Byte,System.Byte},System.Byte[])">
|
995
|
+
<summary>
|
996
|
+
Read a fixed length hello message and identifier from the client
|
997
|
+
</summary></member>
|
998
|
+
<member name="M:KRPC.Server.Stream.StreamServer.DecodeClientIdentifier(System.Byte[])">
|
999
|
+
<summary>
|
1000
|
+
Validate a fixed-length 32-bit identifier, and return it as an int.
|
1001
|
+
</summary>
|
1002
|
+
<returns>The clients GUID.</returns>
|
1003
|
+
<param name="receivedIdentifier">Received identifier.</param></member>
|
1004
|
+
<member name="T:KRPC.Service.Attributes.KRPCClassAttribute">
|
1005
|
+
<summary>
|
1006
|
+
A kRPC class.
|
1007
|
+
</summary></member>
|
1008
|
+
<member name="P:KRPC.Service.Attributes.KRPCClassAttribute.Service">
|
1009
|
+
<summary>
|
1010
|
+
Name of the service in which the class is declared.
|
1011
|
+
</summary></member>
|
1012
|
+
<member name="T:KRPC.Service.Attributes.KRPCEnumAttribute">
|
1013
|
+
<summary>
|
1014
|
+
A kRPC enum.
|
1015
|
+
</summary></member>
|
1016
|
+
<member name="P:KRPC.Service.Attributes.KRPCEnumAttribute.Service">
|
1017
|
+
<summary>
|
1018
|
+
Name of the service in which the enum is declared.
|
1019
|
+
</summary></member>
|
1020
|
+
<member name="T:KRPC.Service.Attributes.KRPCMethodAttribute">
|
1021
|
+
<summary>
|
1022
|
+
A kRPC method.
|
1023
|
+
</summary></member>
|
1024
|
+
<member name="T:KRPC.Service.Attributes.KRPCProcedureAttribute">
|
1025
|
+
<summary>
|
1026
|
+
A kRPC procedure.
|
1027
|
+
</summary></member>
|
1028
|
+
<member name="T:KRPC.Service.Attributes.KRPCPropertyAttribute">
|
1029
|
+
<summary>
|
1030
|
+
A kRPC property.
|
1031
|
+
</summary></member>
|
1032
|
+
<member name="T:KRPC.Service.Attributes.KRPCServiceAttribute">
|
1033
|
+
<summary>
|
1034
|
+
A kRPC service.
|
1035
|
+
</summary></member>
|
1036
|
+
<member name="P:KRPC.Service.Attributes.KRPCServiceAttribute.Name">
|
1037
|
+
<summary>
|
1038
|
+
Name of the service.
|
1039
|
+
</summary></member>
|
1040
|
+
<member name="P:KRPC.Service.Attributes.KRPCServiceAttribute.GameScene">
|
1041
|
+
<summary>
|
1042
|
+
Game scene(s) in which the service is available.
|
1043
|
+
</summary></member>
|
1044
|
+
<member name="M:KRPC.Service.Attributes.KRPCServiceAttribute.#ctor">
|
1045
|
+
<summary>
|
1046
|
+
A kRPC service.
|
1047
|
+
</summary></member>
|
1048
|
+
<member name="T:KRPC.Service.ClassMethodHandler">
|
1049
|
+
<summary>
|
1050
|
+
Used to invoke a class method with the KRPCMethod attribute.
|
1051
|
+
Invoke() gets the instance of the class using the guid
|
1052
|
+
(which is always the first parameter) and runs the method.
|
1053
|
+
</summary></member>
|
1054
|
+
<member name="M:KRPC.Service.ClassMethodHandler.Invoke(System.Object[])">
|
1055
|
+
<summary>
|
1056
|
+
Invokes a method on an object. The first parameter must be an the objects GUID, which is
|
1057
|
+
used to fetch the instance, and the remaining parameters are passed to the method.
|
1058
|
+
</summary></member>
|
1059
|
+
<member name="T:KRPC.Service.ClassStaticMethodHandler">
|
1060
|
+
<summary>
|
1061
|
+
Used to invoke a static method with the KRPCMethod attribute.
|
1062
|
+
Invoke() and runs the static method.
|
1063
|
+
</summary></member>
|
1064
|
+
<member name="M:KRPC.Service.ClassStaticMethodHandler.Invoke(System.Object[])">
|
1065
|
+
<summary>
|
1066
|
+
Invokes the static method.
|
1067
|
+
</summary></member>
|
1068
|
+
<member name="T:KRPC.Service.GameScene">
|
1069
|
+
<summary>
|
1070
|
+
KSP game scenes
|
1071
|
+
</summary></member>
|
1072
|
+
<member name="F:KRPC.Service.GameScene.None">
|
1073
|
+
<summary>
|
1074
|
+
None of the scenes
|
1075
|
+
</summary></member>
|
1076
|
+
<member name="F:KRPC.Service.GameScene.SpaceCenter">
|
1077
|
+
<summary>
|
1078
|
+
The space center overview
|
1079
|
+
</summary></member>
|
1080
|
+
<member name="F:KRPC.Service.GameScene.Flight">
|
1081
|
+
<summary>
|
1082
|
+
When piloting a vessel
|
1083
|
+
</summary></member>
|
1084
|
+
<member name="F:KRPC.Service.GameScene.TrackingStation">
|
1085
|
+
<summary>
|
1086
|
+
The tracking station
|
1087
|
+
</summary></member>
|
1088
|
+
<member name="F:KRPC.Service.GameScene.EditorVAB">
|
1089
|
+
<summary>
|
1090
|
+
The VAB editor
|
1091
|
+
</summary></member>
|
1092
|
+
<member name="F:KRPC.Service.GameScene.EditorSPH">
|
1093
|
+
<summary>
|
1094
|
+
The SPH editor
|
1095
|
+
</summary></member>
|
1096
|
+
<member name="F:KRPC.Service.GameScene.All">
|
1097
|
+
<summary>
|
1098
|
+
All game scenes
|
1099
|
+
</summary></member>
|
1100
|
+
<member name="F:KRPC.Service.GameScene.Editor">
|
1101
|
+
<summary>
|
1102
|
+
The VAB or SPH editors
|
1103
|
+
</summary></member>
|
1104
|
+
<member name="T:KRPC.Service.IProcedureHandler">
|
1105
|
+
<summary>
|
1106
|
+
Use to invoke the method that implement an RPC
|
1107
|
+
</summary></member>
|
1108
|
+
<member name="T:KRPC.Service.KRPC">
|
1109
|
+
<summary>
|
1110
|
+
Main kRPC service, used by clients to interact with basic server functionality.
|
1111
|
+
</summary></member>
|
1112
|
+
<member name="M:KRPC.Service.KRPC.GetStatus">
|
1113
|
+
<summary>
|
1114
|
+
Returns some information about the server, such as the version.
|
1115
|
+
</summary></member>
|
1116
|
+
<member name="M:KRPC.Service.KRPC.GetServices">
|
1117
|
+
<summary>
|
1118
|
+
Returns information on all services, procedures, classes, properties etc. provided by the server.
|
1119
|
+
Can be used by client libraries to automatically create functionality such as stubs.
|
1120
|
+
</summary></member>
|
1121
|
+
<member name="M:KRPC.Service.KRPC.AddStream(KRPC.Schema.KRPC.Request)">
|
1122
|
+
<summary>
|
1123
|
+
Add a streaming request and return its identifier.
|
1124
|
+
</summary></member>
|
1125
|
+
<member name="M:KRPC.Service.KRPC.RemoveStream(System.UInt32)">
|
1126
|
+
<summary>
|
1127
|
+
Remove a streaming request.
|
1128
|
+
</summary></member>
|
1129
|
+
<member name="M:KRPC.Service.ObjectStore.AddInstance(System.Object)">
|
1130
|
+
<summary>
|
1131
|
+
Register an instance with the object store, associating a unique object
|
1132
|
+
identifier with the instance that can be passed to clients.
|
1133
|
+
If the instance has already been added, this just returns it's object identifier.
|
1134
|
+
</summary></member>
|
1135
|
+
<member name="M:KRPC.Service.ObjectStore.RemoveInstance(System.Object)">
|
1136
|
+
<summary>
|
1137
|
+
Remove an instance from the object store.
|
1138
|
+
Note: this doesn't destroy the instance, just removes the reference to it.
|
1139
|
+
</summary></member>
|
1140
|
+
<member name="M:KRPC.Service.ObjectStore.GetInstance(System.UInt64)">
|
1141
|
+
<summary>
|
1142
|
+
Get an instance by it's unique object identifier.
|
1143
|
+
</summary></member>
|
1144
|
+
<member name="M:KRPC.Service.ObjectStore.GetObjectId(System.Object)">
|
1145
|
+
<summary>
|
1146
|
+
Get the object identifier for a given instance.
|
1147
|
+
</summary></member>
|
1148
|
+
<member name="T:KRPC.Service.ProcedureHandler">
|
1149
|
+
<summary>
|
1150
|
+
Used to invoke a static method with the KRPCProcedure attribute.
|
1151
|
+
</summary></member>
|
1152
|
+
<member name="T:KRPC.Service.RequestContinuation">
|
1153
|
+
<summary>
|
1154
|
+
A continuation that runs a client request.
|
1155
|
+
</summary></member>
|
1156
|
+
<member name="T:KRPC.Service.Scanner.ClassSignature">
|
1157
|
+
<summary>
|
1158
|
+
Signature information for a class, including class name and documentation.
|
1159
|
+
</summary></member>
|
1160
|
+
<member name="P:KRPC.Service.Scanner.ClassSignature.Name">
|
1161
|
+
<summary>
|
1162
|
+
Name of the procedure, not including the service it is in.
|
1163
|
+
</summary></member>
|
1164
|
+
<member name="P:KRPC.Service.Scanner.ClassSignature.FullyQualifiedName">
|
1165
|
+
<summary>
|
1166
|
+
Name of the class including the service it is in.
|
1167
|
+
I.e. ServiceName.ClassName
|
1168
|
+
</summary></member>
|
1169
|
+
<member name="P:KRPC.Service.Scanner.ClassSignature.Documentation">
|
1170
|
+
<summary>
|
1171
|
+
Documentation for the procedure
|
1172
|
+
</summary></member>
|
1173
|
+
<member name="T:KRPC.Service.Scanner.EnumerationSignature">
|
1174
|
+
<summary>
|
1175
|
+
Signature information for an enumeration type, including name, values and documentation.
|
1176
|
+
</summary></member>
|
1177
|
+
<member name="P:KRPC.Service.Scanner.EnumerationSignature.Name">
|
1178
|
+
<summary>
|
1179
|
+
Name of the enumeration, not including the service it is in.
|
1180
|
+
</summary></member>
|
1181
|
+
<member name="P:KRPC.Service.Scanner.EnumerationSignature.FullyQualifiedName">
|
1182
|
+
<summary>
|
1183
|
+
Name of the enumeration including the service it is in.
|
1184
|
+
</summary></member>
|
1185
|
+
<member name="P:KRPC.Service.Scanner.EnumerationSignature.Documentation">
|
1186
|
+
<summary>
|
1187
|
+
Documentation for the procedure
|
1188
|
+
</summary></member>
|
1189
|
+
<member name="T:KRPC.Service.Scanner.EnumerationValueSignature">
|
1190
|
+
<summary>
|
1191
|
+
Signature information for an enumeration type, including name, values and documentation.
|
1192
|
+
</summary></member>
|
1193
|
+
<member name="P:KRPC.Service.Scanner.EnumerationValueSignature.Name">
|
1194
|
+
<summary>
|
1195
|
+
Name of the enumeration value.
|
1196
|
+
</summary></member>
|
1197
|
+
<member name="P:KRPC.Service.Scanner.EnumerationValueSignature.FullyQualifiedName">
|
1198
|
+
<summary>
|
1199
|
+
Name of the enumeration value including the service and enum it is in.
|
1200
|
+
</summary></member>
|
1201
|
+
<member name="P:KRPC.Service.Scanner.EnumerationValueSignature.Value">
|
1202
|
+
<summary>
|
1203
|
+
Integer value of the enumeration value.
|
1204
|
+
</summary></member>
|
1205
|
+
<member name="P:KRPC.Service.Scanner.EnumerationValueSignature.Documentation">
|
1206
|
+
<summary>
|
1207
|
+
Documentation for the enumeration value.
|
1208
|
+
</summary></member>
|
1209
|
+
<member name="T:KRPC.Service.Scanner.ParameterSignature">
|
1210
|
+
<summary>
|
1211
|
+
Signature information for a parameter.
|
1212
|
+
</summary></member>
|
1213
|
+
<member name="P:KRPC.Service.Scanner.ParameterSignature.Name">
|
1214
|
+
<summary>
|
1215
|
+
Name of the parameter.
|
1216
|
+
</summary></member>
|
1217
|
+
<member name="P:KRPC.Service.Scanner.ParameterSignature.Type">
|
1218
|
+
<summary>
|
1219
|
+
Type of the parameter.
|
1220
|
+
</summary></member>
|
1221
|
+
<member name="P:KRPC.Service.Scanner.ParameterSignature.DefaultArgument">
|
1222
|
+
<summary>
|
1223
|
+
Serialized value of its default argument, or null if it has no default argument.
|
1224
|
+
</summary></member>
|
1225
|
+
<member name="P:KRPC.Service.Scanner.ParameterSignature.HasDefaultArgument">
|
1226
|
+
<summary>
|
1227
|
+
True if this parameter is optional.
|
1228
|
+
</summary></member>
|
1229
|
+
<member name="T:KRPC.Service.Scanner.ProcedureSignature">
|
1230
|
+
<summary>
|
1231
|
+
Signature information for a procedure, including procedure name,
|
1232
|
+
parameter types and return types.
|
1233
|
+
</summary></member>
|
1234
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.Name">
|
1235
|
+
<summary>
|
1236
|
+
Name of the procedure, not including the service it is in.
|
1237
|
+
</summary></member>
|
1238
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.FullyQualifiedName">
|
1239
|
+
<summary>
|
1240
|
+
Name of the procedure including the service it is in.
|
1241
|
+
I.e. ServiceName.ProcedureName
|
1242
|
+
</summary></member>
|
1243
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.Documentation">
|
1244
|
+
<summary>
|
1245
|
+
Documentation for the procedure
|
1246
|
+
</summary></member>
|
1247
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.Handler">
|
1248
|
+
<summary>
|
1249
|
+
The method that implements the procedure.
|
1250
|
+
</summary></member>
|
1251
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.GameScene">
|
1252
|
+
<summary>
|
1253
|
+
Which game scene(s) the service should be active during
|
1254
|
+
</summary></member>
|
1255
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.ParameterBuilders">
|
1256
|
+
<summary>
|
1257
|
+
Protocol buffer builder objects, used to deserialize parameter values.
|
1258
|
+
</summary></member>
|
1259
|
+
<member name="P:KRPC.Service.Scanner.ProcedureSignature.ReturnBuilder">
|
1260
|
+
<summary>
|
1261
|
+
Protocol buffer builder objects, used to serialize the return value.
|
1262
|
+
</summary></member>
|
1263
|
+
<member name="P:KRPC.Service.Scanner.ServiceSignature.Name">
|
1264
|
+
<summary>
|
1265
|
+
The name of the service
|
1266
|
+
</summary></member>
|
1267
|
+
<member name="P:KRPC.Service.Scanner.ServiceSignature.Documentation">
|
1268
|
+
<summary>
|
1269
|
+
Documentation for the service
|
1270
|
+
</summary></member>
|
1271
|
+
<member name="P:KRPC.Service.Scanner.ServiceSignature.Procedures">
|
1272
|
+
<summary>
|
1273
|
+
A mapping from procedure names to signatures for all RPCs in this service
|
1274
|
+
</summary></member>
|
1275
|
+
<member name="P:KRPC.Service.Scanner.ServiceSignature.Classes">
|
1276
|
+
<summary>
|
1277
|
+
The names of all classes defined in this service
|
1278
|
+
</summary></member>
|
1279
|
+
<member name="P:KRPC.Service.Scanner.ServiceSignature.Enums">
|
1280
|
+
<summary>
|
1281
|
+
The names of all C# defined enums defined in this service, and their allowed values
|
1282
|
+
</summary></member>
|
1283
|
+
<member name="P:KRPC.Service.Scanner.ServiceSignature.GameScene">
|
1284
|
+
<summary>
|
1285
|
+
Which game scene(s) the service should be active during
|
1286
|
+
</summary></member>
|
1287
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.#ctor(System.Type)">
|
1288
|
+
<summary>
|
1289
|
+
Create a service signature from a C# type annotated with the KRPCService attribute
|
1290
|
+
</summary>
|
1291
|
+
<param name="type">Type.</param></member>
|
1292
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.#ctor(System.String)">
|
1293
|
+
<summary>
|
1294
|
+
Create a service with the given name.
|
1295
|
+
</summary></member>
|
1296
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddProcedure(KRPC.Service.Scanner.ProcedureSignature)">
|
1297
|
+
<summary>
|
1298
|
+
Add a procedure to the service
|
1299
|
+
</summary></member>
|
1300
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddProcedure(System.Reflection.MethodInfo)">
|
1301
|
+
<summary>
|
1302
|
+
Add a procedure to the service for the given method annotated with the KRPCProcedure attribute.
|
1303
|
+
</summary></member>
|
1304
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddProperty(System.Reflection.PropertyInfo)">
|
1305
|
+
<summary>
|
1306
|
+
Add a property to the service for the given property annotated with the KRPCProperty attribute.
|
1307
|
+
</summary></member>
|
1308
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddClass(System.Type)">
|
1309
|
+
<summary>
|
1310
|
+
Add a class to the service for the given class type annotated with the KRPCClass attribute.
|
1311
|
+
Returns the name of the class.
|
1312
|
+
</summary></member>
|
1313
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddEnum(System.Type)">
|
1314
|
+
<summary>
|
1315
|
+
Add an enum to the service for the given enum type annotated with the KRPCEnum attribute.
|
1316
|
+
Returns the name of the enumeration.
|
1317
|
+
</summary></member>
|
1318
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddClassMethod(System.String,System.Reflection.MethodInfo)">
|
1319
|
+
<summary>
|
1320
|
+
Add a class method to the given class in the given service for the given class type annotated with the KRPCClass attribute.
|
1321
|
+
</summary></member>
|
1322
|
+
<member name="M:KRPC.Service.Scanner.ServiceSignature.AddClassProperty(System.String,System.Reflection.PropertyInfo)">
|
1323
|
+
<summary>
|
1324
|
+
Add a class property to the given class in the given service for the given property annotated with the KRPCProperty attribute.
|
1325
|
+
</summary></member>
|
1326
|
+
<member name="M:KRPC.Service.Services.#ctor">
|
1327
|
+
<summary>
|
1328
|
+
Create a Services instance. Scans the loaded assemblies for services, procedures etc.
|
1329
|
+
</summary></member>
|
1330
|
+
<member name="M:KRPC.Service.Services.HandleRequest(KRPC.Service.Scanner.ProcedureSignature,KRPC.Schema.KRPC.Request)">
|
1331
|
+
<summary>
|
1332
|
+
Executes the given request and returns a response builder with the relevant
|
1333
|
+
fields populated. Throws YieldException, containing a continuation, if the request yields.
|
1334
|
+
Throws RPCException if processing the request fails.
|
1335
|
+
</summary></member>
|
1336
|
+
<member name="M:KRPC.Service.Services.HandleRequest(KRPC.Service.Scanner.ProcedureSignature,System.Object[])">
|
1337
|
+
<summary>
|
1338
|
+
Executes a request (from an array of decoded arguments) and returns a response builder with the relevant
|
1339
|
+
fields populated. Throws YieldException, containing a continuation, if the request yields.
|
1340
|
+
Throws RPCException if processing the request fails.
|
1341
|
+
</summary></member>
|
1342
|
+
<member name="M:KRPC.Service.Services.HandleRequest(KRPC.Service.Scanner.ProcedureSignature,KRPC.Continuations.IContinuation)">
|
1343
|
+
<summary>
|
1344
|
+
Executes the request, continuing using the given continuation. Returns a response builder with the relevant
|
1345
|
+
fields populated. Throws YieldException, containing a continuation, if the request yields.
|
1346
|
+
Throws RPCException if processing the request fails.
|
1347
|
+
</summary></member>
|
1348
|
+
<member name="M:KRPC.Service.Services.DecodeArguments(KRPC.Service.Scanner.ProcedureSignature,KRPC.Schema.KRPC.Request)">
|
1349
|
+
<summary>
|
1350
|
+
Decode the arguments for a request
|
1351
|
+
</summary></member>
|
1352
|
+
<member name="M:KRPC.Service.Services.DecodeArguments(KRPC.Service.Scanner.ProcedureSignature,System.Collections.Generic.IList{KRPC.Schema.KRPC.Argument})">
|
1353
|
+
<summary>
|
1354
|
+
Decode the arguments for a procedure from a serialized request
|
1355
|
+
</summary></member>
|
1356
|
+
<member name="M:KRPC.Service.Services.Decode(KRPC.Service.Scanner.ProcedureSignature,System.Int32,System.Type,Google.ProtocolBuffers.ByteString)">
|
1357
|
+
<summary>
|
1358
|
+
Decode a serialized value
|
1359
|
+
</summary></member>
|
1360
|
+
<member name="M:KRPC.Service.Services.DecodeCollection(KRPC.Service.Scanner.ProcedureSignature,System.Int32,System.Type,Google.ProtocolBuffers.ByteString)">
|
1361
|
+
<summary>
|
1362
|
+
Decode a serialized collection
|
1363
|
+
</summary></member>
|
1364
|
+
<member name="M:KRPC.Service.Services.EncodeReturnValue(KRPC.Service.Scanner.ProcedureSignature,System.Object)">
|
1365
|
+
<summary>
|
1366
|
+
Encodes the value returned by a procedure handler into a ByteString
|
1367
|
+
</summary></member>
|
1368
|
+
<member name="M:KRPC.Service.Services.Encode(System.Type,System.Object)">
|
1369
|
+
<summary>
|
1370
|
+
Encode a value
|
1371
|
+
</summary></member>
|
1372
|
+
<member name="M:KRPC.Service.Services.EncodeCollection(System.Type,System.Object)">
|
1373
|
+
<summary>
|
1374
|
+
Encode a collection
|
1375
|
+
</summary></member>
|
1376
|
+
<member name="M:KRPC.Service.TypeUtils.IsAValidIdentifier(System.String)">
|
1377
|
+
<summary>
|
1378
|
+
Returns true if the given identifier is a valid kRPC identifier.
|
1379
|
+
A valid identifier is a non-zero length string, containing letters and numbers,
|
1380
|
+
and starting with a letter.
|
1381
|
+
</summary></member>
|
1382
|
+
<member name="M:KRPC.Service.TypeUtils.IsAValidType(System.Type)">
|
1383
|
+
<summary>
|
1384
|
+
Returns true if the given type can be used as a kRPC type
|
1385
|
+
</summary></member>
|
1386
|
+
<member name="M:KRPC.Service.TypeUtils.IsAValidKeyType(System.Type)">
|
1387
|
+
<summary>
|
1388
|
+
Returns true if the given type can be used as a kRPC key type
|
1389
|
+
</summary></member>
|
1390
|
+
<member name="M:KRPC.Service.TypeUtils.IsAClassType(System.Type)">
|
1391
|
+
<summary>
|
1392
|
+
Returns true if the given type can be used as a kRPC class type
|
1393
|
+
</summary></member>
|
1394
|
+
<member name="M:KRPC.Service.TypeUtils.IsAnEnumType(System.Type)">
|
1395
|
+
<summary>
|
1396
|
+
Returns true if the given type can be used as a kRPC enum type
|
1397
|
+
</summary></member>
|
1398
|
+
<member name="M:KRPC.Service.TypeUtils.IsACollectionType(System.Type)">
|
1399
|
+
<summary>
|
1400
|
+
Returns true if the given type can be used as a kRPC collection type
|
1401
|
+
</summary></member>
|
1402
|
+
<member name="M:KRPC.Service.TypeUtils.IsAListCollectionType(System.Type)">
|
1403
|
+
<summary>
|
1404
|
+
Returns true if the given type can be used as a kRPC list collection type
|
1405
|
+
</summary></member>
|
1406
|
+
<member name="M:KRPC.Service.TypeUtils.IsADictionaryCollectionType(System.Type)">
|
1407
|
+
<summary>
|
1408
|
+
Returns true if the given type can be used as a kRPC dictionary collection type
|
1409
|
+
</summary></member>
|
1410
|
+
<member name="M:KRPC.Service.TypeUtils.IsASetCollectionType(System.Type)">
|
1411
|
+
<summary>
|
1412
|
+
Returns true if the given type can be used as a kRPC list collection type
|
1413
|
+
</summary></member>
|
1414
|
+
<member name="M:KRPC.Service.TypeUtils.IsATupleCollectionType(System.Type)">
|
1415
|
+
<summary>
|
1416
|
+
Returns true if the given type can be used as a kRPC tuple collection type
|
1417
|
+
</summary></member>
|
1418
|
+
<member name="M:KRPC.Service.TypeUtils.GetTypeName(System.Type)">
|
1419
|
+
<summary>
|
1420
|
+
Return the name of the protocol buffer type for the given C# type
|
1421
|
+
</summary></member>
|
1422
|
+
<member name="M:KRPC.Service.TypeUtils.GetKRPCTypeName(System.Type)">
|
1423
|
+
<summary>
|
1424
|
+
Return the name of the kRPC type for the given C# type
|
1425
|
+
</summary></member>
|
1426
|
+
<member name="M:KRPC.Service.TypeUtils.ParameterTypeAttributes(System.Int32,System.Type)">
|
1427
|
+
<summary>
|
1428
|
+
Get the parameter type attributes for the given kRPC procedure parameter
|
1429
|
+
</summary></member>
|
1430
|
+
<member name="M:KRPC.Service.TypeUtils.ReturnTypeAttributes(System.Type)">
|
1431
|
+
<summary>
|
1432
|
+
Get the return type attributes for the given type
|
1433
|
+
</summary></member>
|
1434
|
+
<member name="M:KRPC.Service.TypeUtils.GetServiceName(System.Type)">
|
1435
|
+
<summary>
|
1436
|
+
Get the name of the service for the given KRPCService annotated type
|
1437
|
+
</summary></member>
|
1438
|
+
<member name="M:KRPC.Service.TypeUtils.GetServiceGameScene(System.Type)">
|
1439
|
+
<summary>
|
1440
|
+
Get the GameScene that the service should active during
|
1441
|
+
</summary></member>
|
1442
|
+
<member name="M:KRPC.Service.TypeUtils.GetClassServiceName(System.Type)">
|
1443
|
+
<summary>
|
1444
|
+
Get the name of the service for the given KRPCClass annotated type
|
1445
|
+
</summary></member>
|
1446
|
+
<member name="M:KRPC.Service.TypeUtils.GetEnumServiceName(System.Type)">
|
1447
|
+
<summary>
|
1448
|
+
Get the name of the service for the given KRPCEnum annotated type
|
1449
|
+
</summary></member>
|
1450
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateIdentifier(System.String)">
|
1451
|
+
<summary>
|
1452
|
+
Check if the string is a valid identifier for a kRPC service, procedure, property, class or method.
|
1453
|
+
</summary></member>
|
1454
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCService(System.Type)">
|
1455
|
+
<summary>
|
1456
|
+
Check the given type is a valid kRPC service
|
1457
|
+
1. Must have KRPCService attribute
|
1458
|
+
2. Must have a valid identifier
|
1459
|
+
3. Must be a public static class
|
1460
|
+
4. Must not be declared inside another kRPC service
|
1461
|
+
</summary></member>
|
1462
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCProcedure(System.Reflection.MethodInfo)">
|
1463
|
+
<summary>
|
1464
|
+
Check the given method is a valid kRPC procedure
|
1465
|
+
1. Must have KRPCProcedure attribute
|
1466
|
+
2. Must have a valid identifier
|
1467
|
+
3. Must be a public static method
|
1468
|
+
4. Must be declared inside a kRPC service
|
1469
|
+
</summary></member>
|
1470
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCProperty(System.Reflection.PropertyInfo)">
|
1471
|
+
<summary>
|
1472
|
+
Check the given type is a valid kRPC property
|
1473
|
+
1. Must have KRPCProperty attribute
|
1474
|
+
2. Must have a valid identifier
|
1475
|
+
3. Must be a public static property
|
1476
|
+
4. Must be declared inside a kRPC service
|
1477
|
+
</summary></member>
|
1478
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCClass(System.Type)">
|
1479
|
+
<summary>
|
1480
|
+
Check the given type is a valid kRPC class
|
1481
|
+
1. Must have KRPCClass attribute
|
1482
|
+
2. Must have a valid identifier
|
1483
|
+
3. Must be a public non-static class
|
1484
|
+
4. Must be declared inside a kRPC service if it doesn't have the service explicity set
|
1485
|
+
5. Must not be declared inside a kRPC service if it does have the service explicity set
|
1486
|
+
</summary></member>
|
1487
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCEnum(System.Type)">
|
1488
|
+
<summary>
|
1489
|
+
Check the given type is a valid kRPC enumeration
|
1490
|
+
1. Must have KRPCEnum attribute
|
1491
|
+
2. Must have a valid identifier
|
1492
|
+
3. Must be a public enum
|
1493
|
+
4. Underlying type must be a 32-bit signed integer (int)
|
1494
|
+
5. Must be declared inside a kRPC service if it doesn't have the service explicity set
|
1495
|
+
6. Must not be declared inside a kRPC service if it does have the service explicity set
|
1496
|
+
</summary></member>
|
1497
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCMethod(System.Reflection.MethodInfo)">
|
1498
|
+
<summary>
|
1499
|
+
Check the given method is a valid kRPC class method
|
1500
|
+
1. Must have KRPCMethod attribute
|
1501
|
+
2. Must have a valid identifier
|
1502
|
+
3. Must be a public method
|
1503
|
+
4. Must be declared inside a kRPC class
|
1504
|
+
</summary></member>
|
1505
|
+
<member name="M:KRPC.Service.TypeUtils.ValidateKRPCClassProperty(System.Reflection.PropertyInfo)">
|
1506
|
+
<summary>
|
1507
|
+
Check the given type is a valid kRPC class property
|
1508
|
+
1. Must have KRPCProperty attribute
|
1509
|
+
2. Must have a valid identifier
|
1510
|
+
3. Must be a public non-static property
|
1511
|
+
4. Must be declared inside a kRPC class
|
1512
|
+
</summary></member>
|
1513
|
+
<member name="F:KRPC.UI.Icons.iconsPath">
|
1514
|
+
<summary>
|
1515
|
+
Path to directory in GameData when icons are stored
|
1516
|
+
</summary></member>
|
1517
|
+
<member name="M:KRPC.UI.Icons.LoadTexture(System.String)">
|
1518
|
+
<summary>
|
1519
|
+
Load a file as a 2D texture.
|
1520
|
+
</summary></member>
|
1521
|
+
<member name="P:KRPC.UI.MainWindow.Errors">
|
1522
|
+
<summary>
|
1523
|
+
Errors to display
|
1524
|
+
</summary></member>
|
1525
|
+
<member name="T:KRPC.UI.ToolbarManager">
|
1526
|
+
********************************************************\
|
1527
|
+
* --- DO NOT EDIT BELOW THIS COMMENT --- *
|
1528
|
+
* *
|
1529
|
+
* This file contains classes and interfaces to use the *
|
1530
|
+
* Toolbar Plugin without creating a hard dependency on it. *
|
1531
|
+
* *
|
1532
|
+
* There is nothing in this file that needs to be edited *
|
1533
|
+
* by hand. *
|
1534
|
+
* *
|
1535
|
+
* --- DO NOT EDIT BELOW THIS COMMENT --- *
|
1536
|
+
\*********************************************************<summary>
|
1537
|
+
The global tool bar manager.
|
1538
|
+
</summary></member>
|
1539
|
+
<member name="P:KRPC.UI.ToolbarManager.ToolbarAvailable">
|
1540
|
+
<summary>
|
1541
|
+
Whether the Toolbar Plugin is available.
|
1542
|
+
</summary></member>
|
1543
|
+
<member name="P:KRPC.UI.ToolbarManager.Instance">
|
1544
|
+
<summary>
|
1545
|
+
The global tool bar manager instance.
|
1546
|
+
</summary></member>
|
1547
|
+
<member name="T:KRPC.UI.IToolbarManager">
|
1548
|
+
<summary>
|
1549
|
+
A toolbar manager.
|
1550
|
+
</summary></member>
|
1551
|
+
<member name="M:KRPC.UI.IToolbarManager.add(System.String,System.String)">
|
1552
|
+
<summary>
|
1553
|
+
Adds a new button.
|
1554
|
+
</summary>
|
1555
|
+
<remarks>
|
1556
|
+
To replace an existing button, just add a new button using the old button's namespace and ID.
|
1557
|
+
Note that the new button will inherit the screen position of the old button.
|
1558
|
+
</remarks>
|
1559
|
+
<param name="ns">The new button's namespace. This is usually the plugin's name. Must not include special characters like '.'</param>
|
1560
|
+
<param name="id">The new button's ID. This ID must be unique across all buttons in the namespace. Must not include special characters like '.'</param>
|
1561
|
+
<returns>The button created.</returns></member>
|
1562
|
+
<member name="T:KRPC.UI.IButton">
|
1563
|
+
<summary>
|
1564
|
+
Represents a clickable button.
|
1565
|
+
</summary></member>
|
1566
|
+
<member name="P:KRPC.UI.IButton.Text">
|
1567
|
+
<summary>
|
1568
|
+
The text displayed on the button. Set to null to hide text.
|
1569
|
+
</summary>
|
1570
|
+
<remarks>
|
1571
|
+
The text can be changed at any time to modify the button's appearance. Note that since this will also
|
1572
|
+
modify the button's size, this feature should be used sparingly, if at all.
|
1573
|
+
</remarks>
|
1574
|
+
<seealso cref="P:KRPC.UI.IButton.TexturePath" /></member>
|
1575
|
+
<member name="P:KRPC.UI.IButton.TextColor">
|
1576
|
+
<summary>
|
1577
|
+
The color the button text is displayed with. Defaults to Color.white.
|
1578
|
+
</summary>
|
1579
|
+
<remarks>
|
1580
|
+
The text color can be changed at any time to modify the button's appearance.
|
1581
|
+
</remarks></member>
|
1582
|
+
<member name="P:KRPC.UI.IButton.TexturePath">
|
1583
|
+
<summary>
|
1584
|
+
The path of a texture file to display an icon on the button. Set to null to hide icon.
|
1585
|
+
</summary>
|
1586
|
+
<remarks>
|
1587
|
+
<para>
|
1588
|
+
A texture path on a button will have precedence over text. That is, if both text and texture path
|
1589
|
+
have been set on a button, the button will show the texture, not the text.
|
1590
|
+
</para>
|
1591
|
+
<para>
|
1592
|
+
The texture size must not exceed 24x24 pixels.
|
1593
|
+
</para>
|
1594
|
+
<para>
|
1595
|
+
The texture path must be relative to the "GameData" directory, and must not specify a file name suffix.
|
1596
|
+
Valid example: MyAddon/Textures/icon_mybutton
|
1597
|
+
</para>
|
1598
|
+
<para>
|
1599
|
+
The texture path can be changed at any time to modify the button's appearance.
|
1600
|
+
</para>
|
1601
|
+
</remarks>
|
1602
|
+
<seealso cref="P:KRPC.UI.IButton.Text" /></member>
|
1603
|
+
<member name="P:KRPC.UI.IButton.ToolTip">
|
1604
|
+
<summary>
|
1605
|
+
The button's tool tip text. Set to null if no tool tip is desired.
|
1606
|
+
</summary>
|
1607
|
+
<remarks>
|
1608
|
+
Tool Tip Text Should Always Use Headline Style Like This.
|
1609
|
+
</remarks></member>
|
1610
|
+
<member name="P:KRPC.UI.IButton.Visible">
|
1611
|
+
<summary>
|
1612
|
+
Whether this button is currently visible or not. Can be used in addition to or as a replacement for <see cref="T:Visibility" />.
|
1613
|
+
</summary>
|
1614
|
+
<remarks>
|
1615
|
+
Setting this property to true does not affect the player's ability to hide the button using the configuration.
|
1616
|
+
Conversely, setting this property to false does not enable the player to show the button using the configuration.
|
1617
|
+
</remarks></member>
|
1618
|
+
<member name="P:KRPC.UI.IButton.Visibility">
|
1619
|
+
<summary>
|
1620
|
+
Determines this button's visibility. Can be used in addition to or as a replacement for <see cref="P:KRPC.UI.IButton.Visible" />.
|
1621
|
+
</summary>
|
1622
|
+
<remarks>
|
1623
|
+
The return value from IVisibility.Visible is subject to the same rules as outlined for
|
1624
|
+
<see cref="P:KRPC.UI.IButton.Visible" />.
|
1625
|
+
</remarks></member>
|
1626
|
+
<member name="P:KRPC.UI.IButton.EffectivelyVisible">
|
1627
|
+
<summary>
|
1628
|
+
Whether this button is currently effectively visible or not. This is a combination of
|
1629
|
+
<see cref="P:KRPC.UI.IButton.Visible" /> and <see cref="T:Visibility" />.
|
1630
|
+
</summary>
|
1631
|
+
<remarks>
|
1632
|
+
Note that the toolbar is not visible in certain game scenes, for example the loading screens. This property
|
1633
|
+
does not reflect button invisibility in those scenes. In addition, this property does not reflect the
|
1634
|
+
player's configuration of the button's visibility.
|
1635
|
+
</remarks></member>
|
1636
|
+
<member name="P:KRPC.UI.IButton.Enabled">
|
1637
|
+
<summary>
|
1638
|
+
Whether this button is currently enabled (clickable) or not. This does not affect the player's ability to
|
1639
|
+
position the button on their toolbar.
|
1640
|
+
</summary></member>
|
1641
|
+
<member name="P:KRPC.UI.IButton.Important">
|
1642
|
+
<summary>
|
1643
|
+
Whether this button is currently "important." Set to false to return to normal button behaviour.
|
1644
|
+
</summary>
|
1645
|
+
<remarks>
|
1646
|
+
<para>
|
1647
|
+
This can be used to temporarily force the button to be shown on screen regardless of the toolbar being
|
1648
|
+
currently in auto-hidden mode. For example, a button that signals the arrival of a private message in
|
1649
|
+
a chat room could mark itself as "important" as long as the message has not been read.
|
1650
|
+
</para>
|
1651
|
+
<para>
|
1652
|
+
Setting this property does not change the appearance of the button. Use <see cref="P:KRPC.UI.IButton.TexturePath" /> to
|
1653
|
+
change the button's icon.
|
1654
|
+
</para>
|
1655
|
+
<para>
|
1656
|
+
Setting this property to true does not affect the player's ability to hide the button using the
|
1657
|
+
configuration.
|
1658
|
+
</para>
|
1659
|
+
<para>
|
1660
|
+
This feature should be used only sparingly, if at all, since it forces the button to be displayed on
|
1661
|
+
screen even when it normally wouldn't.
|
1662
|
+
</para>
|
1663
|
+
</remarks></member>
|
1664
|
+
<member name="P:KRPC.UI.IButton.Drawable">
|
1665
|
+
<summary>
|
1666
|
+
A drawable that is tied to the current button. This can be anything from a popup menu to
|
1667
|
+
an informational window. Set to null to hide the drawable.
|
1668
|
+
</summary></member>
|
1669
|
+
<member name="E:KRPC.UI.IButton.OnClick">
|
1670
|
+
<summary>
|
1671
|
+
Event handler that can be registered with to receive "on click" events.
|
1672
|
+
</summary>
|
1673
|
+
<example>
|
1674
|
+
<code>
|
1675
|
+
IButton button = ...
|
1676
|
+
button.OnClick += (e) => {
|
1677
|
+
Debug.Log("button clicked, mouseButton: " + e.MouseButton);
|
1678
|
+
};
|
1679
|
+
</code>
|
1680
|
+
</example></member>
|
1681
|
+
<member name="E:KRPC.UI.IButton.OnMouseEnter">
|
1682
|
+
<summary>
|
1683
|
+
Event handler that can be registered with to receive "on mouse enter" events.
|
1684
|
+
</summary>
|
1685
|
+
<example>
|
1686
|
+
<code>
|
1687
|
+
IButton button = ...
|
1688
|
+
button.OnMouseEnter += (e) => {
|
1689
|
+
Debug.Log("mouse entered button");
|
1690
|
+
};
|
1691
|
+
</code>
|
1692
|
+
</example></member>
|
1693
|
+
<member name="E:KRPC.UI.IButton.OnMouseLeave">
|
1694
|
+
<summary>
|
1695
|
+
Event handler that can be registered with to receive "on mouse leave" events.
|
1696
|
+
</summary>
|
1697
|
+
<example>
|
1698
|
+
<code>
|
1699
|
+
IButton button = ...
|
1700
|
+
button.OnMouseLeave += (e) => {
|
1701
|
+
Debug.Log("mouse left button");
|
1702
|
+
};
|
1703
|
+
</code>
|
1704
|
+
</example></member>
|
1705
|
+
<member name="M:KRPC.UI.IButton.Destroy">
|
1706
|
+
<summary>
|
1707
|
+
Permanently destroys this button so that it is no longer displayed.
|
1708
|
+
Should be used when a plugin is stopped to remove leftover buttons.
|
1709
|
+
</summary></member>
|
1710
|
+
<member name="T:KRPC.UI.IDrawable">
|
1711
|
+
<summary>
|
1712
|
+
A drawable that is tied to a particular button. This can be anything from a popup menu
|
1713
|
+
to an informational window.
|
1714
|
+
</summary></member>
|
1715
|
+
<member name="M:KRPC.UI.IDrawable.Update">
|
1716
|
+
<summary>
|
1717
|
+
Update any information. This is called once per frame.
|
1718
|
+
</summary></member>
|
1719
|
+
<member name="M:KRPC.UI.IDrawable.Draw(UnityEngine.Vector2)">
|
1720
|
+
<summary>
|
1721
|
+
Draws GUI widgets for this drawable. This is the equivalent to the OnGUI() message in
|
1722
|
+
<see cref="T:UnityEngine.MonoBehaviour" />.
|
1723
|
+
</summary>
|
1724
|
+
<remarks>
|
1725
|
+
The drawable will be positioned near its parent toolbar according to the drawable's current
|
1726
|
+
width/height.
|
1727
|
+
</remarks>
|
1728
|
+
<param name="position">The left/top position of where to draw this drawable.</param>
|
1729
|
+
<returns>The current width/height of this drawable.</returns></member>
|
1730
|
+
<member name="T:KRPC.UI.ClickEvent">
|
1731
|
+
<summary>
|
1732
|
+
Event describing a click on a button.
|
1733
|
+
</summary></member>
|
1734
|
+
<member name="F:KRPC.UI.ClickEvent.Button">
|
1735
|
+
<summary>
|
1736
|
+
The button that has been clicked.
|
1737
|
+
</summary></member>
|
1738
|
+
<member name="F:KRPC.UI.ClickEvent.MouseButton">
|
1739
|
+
<summary>
|
1740
|
+
The mouse button which the button was clicked with.
|
1741
|
+
</summary>
|
1742
|
+
<remarks>
|
1743
|
+
Is 0 for left mouse button, 1 for right mouse button, and 2 for middle mouse button.
|
1744
|
+
</remarks></member>
|
1745
|
+
<member name="T:KRPC.UI.ClickHandler">
|
1746
|
+
<summary>
|
1747
|
+
An event handler that is invoked whenever a button has been clicked.
|
1748
|
+
</summary>
|
1749
|
+
<param name="e">An event describing the button click.</param></member>
|
1750
|
+
<member name="T:KRPC.UI.MouseMoveEvent">
|
1751
|
+
<summary>
|
1752
|
+
Event describing the mouse pointer moving about a button.
|
1753
|
+
</summary></member>
|
1754
|
+
<member name="F:KRPC.UI.MouseMoveEvent.button">
|
1755
|
+
<summary>
|
1756
|
+
The button in question.
|
1757
|
+
</summary></member>
|
1758
|
+
<member name="T:KRPC.UI.MouseEnterEvent">
|
1759
|
+
<summary>
|
1760
|
+
Event describing the mouse pointer entering a button's area.
|
1761
|
+
</summary></member>
|
1762
|
+
<member name="T:KRPC.UI.MouseLeaveEvent">
|
1763
|
+
<summary>
|
1764
|
+
Event describing the mouse pointer leaving a button's area.
|
1765
|
+
</summary></member>
|
1766
|
+
<member name="T:KRPC.UI.MouseEnterHandler">
|
1767
|
+
<summary>
|
1768
|
+
An event handler that is invoked whenever the mouse pointer enters a button's area.
|
1769
|
+
</summary>
|
1770
|
+
<param name="e">An event describing the mouse pointer entering.</param></member>
|
1771
|
+
<member name="T:KRPC.UI.MouseLeaveHandler">
|
1772
|
+
<summary>
|
1773
|
+
An event handler that is invoked whenever the mouse pointer leaves a button's area.
|
1774
|
+
</summary>
|
1775
|
+
<param name="e">An event describing the mouse pointer leaving.</param></member>
|
1776
|
+
<member name="T:KRPC.UI.IVisibility">
|
1777
|
+
<summary>
|
1778
|
+
Determines visibility of a button.
|
1779
|
+
</summary>
|
1780
|
+
<seealso cref="P:KRPC.UI.IButton.Visibility" /></member>
|
1781
|
+
<member name="P:KRPC.UI.IVisibility.Visible">
|
1782
|
+
<summary>
|
1783
|
+
Whether a button is currently visible or not.
|
1784
|
+
</summary>
|
1785
|
+
<seealso cref="P:KRPC.UI.IButton.Visible" /></member>
|
1786
|
+
<member name="T:KRPC.UI.GameScenesVisibility">
|
1787
|
+
<summary>
|
1788
|
+
Determines visibility of a button in relation to the currently running game scene.
|
1789
|
+
</summary>
|
1790
|
+
<example>
|
1791
|
+
<code>
|
1792
|
+
IButton button = ...
|
1793
|
+
button.Visibility = new GameScenesVisibility(GameScenes.EDITOR, GameScenes.SPH);
|
1794
|
+
</code>
|
1795
|
+
</example>
|
1796
|
+
<seealso cref="P:KRPC.UI.IButton.Visibility" /></member>
|
1797
|
+
<member name="T:KRPC.UI.PopupMenuDrawable">
|
1798
|
+
<summary>
|
1799
|
+
A drawable that draws a popup menu.
|
1800
|
+
</summary></member>
|
1801
|
+
<member name="E:KRPC.UI.PopupMenuDrawable.OnAnyOptionClicked">
|
1802
|
+
<summary>
|
1803
|
+
Event handler that can be registered with to receive "any menu option clicked" events.
|
1804
|
+
</summary></member>
|
1805
|
+
<member name="M:KRPC.UI.PopupMenuDrawable.AddOption(System.String)">
|
1806
|
+
<summary>
|
1807
|
+
Adds a new option to the popup menu.
|
1808
|
+
</summary>
|
1809
|
+
<param name="text">The text of the option.</param>
|
1810
|
+
<returns>A button that can be used to register clicks on the menu option.</returns></member>
|
1811
|
+
<member name="M:KRPC.UI.PopupMenuDrawable.AddSeparator">
|
1812
|
+
<summary>
|
1813
|
+
Adds a separator to the popup menu.
|
1814
|
+
</summary></member>
|
1815
|
+
<member name="M:KRPC.UI.PopupMenuDrawable.Destroy">
|
1816
|
+
<summary>
|
1817
|
+
Destroys this drawable. This must always be called before disposing of this drawable.
|
1818
|
+
</summary></member>
|
1819
|
+
<member name="M:KRPC.Utils.ConfigurationStorage.#ctor(System.String)">
|
1820
|
+
<summary>
|
1821
|
+
Create a configuration object with default values. Call Load() to load from the file.
|
1822
|
+
The file path is relative to the directory containing this assembly.
|
1823
|
+
</summary></member>
|
1824
|
+
<member name="M:KRPC.Utils.ConfigurationStorage.Load">
|
1825
|
+
<summary>
|
1826
|
+
Load settings from the underlying storage
|
1827
|
+
</summary></member>
|
1828
|
+
<member name="M:KRPC.Utils.ConfigurationStorage.Save">
|
1829
|
+
<summary>
|
1830
|
+
Save settings to the underlying storage
|
1831
|
+
</summary></member>
|
1832
|
+
<member name="M:KRPC.Utils.ConfigurationStorageNode.BeforeSave">
|
1833
|
+
<summary>
|
1834
|
+
Override to provide custom behaviour before saving.
|
1835
|
+
</summary></member>
|
1836
|
+
<member name="M:KRPC.Utils.ConfigurationStorageNode.AfterLoad">
|
1837
|
+
<summary>
|
1838
|
+
Override to provide custom behaviour after loading.
|
1839
|
+
</summary></member>
|
1840
|
+
<member name="M:KRPC.Utils.DocumentationExtensions.Dedent(System.String)">
|
1841
|
+
<summary>
|
1842
|
+
Remove indentiation from a multi-line string, where the first line
|
1843
|
+
is not indented, and following lines are indented.
|
1844
|
+
</summary></member>
|
1845
|
+
<member name="T:KRPC.Utils.Equatable`1">
|
1846
|
+
<summary>
|
1847
|
+
Abstract base class for equatable objects.
|
1848
|
+
Provides implementations of comparison operators.
|
1849
|
+
</summary></member>
|
1850
|
+
<member name="M:KRPC.Utils.Equatable`1.Equals(`0)">
|
1851
|
+
<summary>
|
1852
|
+
Returns true if the objects are equal
|
1853
|
+
</summary></member>
|
1854
|
+
<member name="M:KRPC.Utils.Equatable`1.GetHashCode">
|
1855
|
+
<summary>
|
1856
|
+
Hash function
|
1857
|
+
</summary></member>
|
1858
|
+
<member name="M:KRPC.Utils.Equatable`1.Equals(System.Object)">
|
1859
|
+
<summary>
|
1860
|
+
Returns true if the objects are equal
|
1861
|
+
</summary></member>
|
1862
|
+
<member name="M:KRPC.Utils.Equatable`1.op_Equality(KRPC.Utils.Equatable{`0},KRPC.Utils.Equatable{`0})">
|
1863
|
+
<summary>
|
1864
|
+
Returns true if the lhs equals the rhs
|
1865
|
+
</summary></member>
|
1866
|
+
<member name="M:KRPC.Utils.Equatable`1.op_Inequality(KRPC.Utils.Equatable{`0},KRPC.Utils.Equatable{`0})">
|
1867
|
+
<summary>
|
1868
|
+
Returns true if the lhs does not equal the rhs
|
1869
|
+
</summary></member>
|
1870
|
+
<member name="T:KRPC.Utils.KSPAddonImproved">
|
1871
|
+
<remarks>
|
1872
|
+
Adapted from public domain code by Majiir
|
1873
|
+
http://forum.kerbalspaceprogram.com/threads/79889-Expanded-KSPAddon-modes
|
1874
|
+
</remarks></member>
|
1875
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.GetMessageTypeName(System.Type)">
|
1876
|
+
<summary>
|
1877
|
+
Return the string name of the Protocol Buffer message type (with the package name prefixing it).
|
1878
|
+
E.g. "KRPC.Request"
|
1879
|
+
</summary></member>
|
1880
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.GetEnumTypeName(System.Type)">
|
1881
|
+
<summary>
|
1882
|
+
Return the string name of the Protocol Buffer enumeration type (with the package name prefixing it).
|
1883
|
+
</summary></member>
|
1884
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.GetValueTypeName(System.Type)">
|
1885
|
+
<summary>
|
1886
|
+
Return the string name of the Protocol Buffer message type corresponding to the given type.
|
1887
|
+
E.g. "uint32" for uint
|
1888
|
+
</summary></member>
|
1889
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.GetTypeName(System.Type)">
|
1890
|
+
<summary>
|
1891
|
+
Return the string name of the Protocol Buffer message, enumeration or value type.
|
1892
|
+
</summary></member>
|
1893
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.BuilderForMessageType(System.Type)">
|
1894
|
+
<summary>
|
1895
|
+
Return a builder object for the given Protocol Buffer message type.
|
1896
|
+
The type must be derived from IMessage.
|
1897
|
+
</summary></member>
|
1898
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.IsAMessageType(System.Type)">
|
1899
|
+
<summary>
|
1900
|
+
Returns true if the given type is a Protocol Buffer message type.
|
1901
|
+
</summary></member>
|
1902
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.IsAnEnumType(System.Type)">
|
1903
|
+
<summary>
|
1904
|
+
Returns true if the given type is a Protocol Buffer enumeration type.
|
1905
|
+
</summary></member>
|
1906
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.IsAValueType(System.Type)">
|
1907
|
+
<summary>
|
1908
|
+
Returns true if the given type is a Protocol Buffer value type.
|
1909
|
+
</summary></member>
|
1910
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.IsAValidType(System.Type)">
|
1911
|
+
<summary>
|
1912
|
+
Returns true if the given type is a Protocol Buffer message or value type.
|
1913
|
+
</summary></member>
|
1914
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.WriteMessage(Google.ProtocolBuffers.IMessage)">
|
1915
|
+
<summary>
|
1916
|
+
Convert a Protocol Buffer message to a byte string.
|
1917
|
+
</summary></member>
|
1918
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.ReadValue(Google.ProtocolBuffers.ByteString,System.Type)">
|
1919
|
+
<summary>
|
1920
|
+
Convert a Protocol Buffer value type, encoded as a byte string, to a C# value.
|
1921
|
+
</summary></member>
|
1922
|
+
<member name="M:KRPC.Utils.ProtocolBuffers.WriteValue(System.Object,System.Type)">
|
1923
|
+
<summary>
|
1924
|
+
Convert a Protocol Buffer value type from a C# value to a byte string.
|
1925
|
+
</summary></member>
|
1926
|
+
<member name="M:KRPC.Utils.Reflection.GetType(System.String)">
|
1927
|
+
<summary>
|
1928
|
+
Returns the type with the specified full name, from all assemblies, or null if no such type exists.
|
1929
|
+
</summary></member>
|
1930
|
+
<member name="M:KRPC.Utils.Reflection.GetTypesWith``1(System.Boolean)">
|
1931
|
+
<summary>
|
1932
|
+
Returns all types with the specified attribute, from all assemblies.
|
1933
|
+
</summary></member>
|
1934
|
+
<member name="M:KRPC.Utils.Reflection.GetMethodsWith``1(System.Type,System.Boolean)">
|
1935
|
+
<summary>
|
1936
|
+
Returns all methods within a given type that have the specified attribute.
|
1937
|
+
</summary></member>
|
1938
|
+
<member name="M:KRPC.Utils.Reflection.GetPropertiesWith``1(System.Type,System.Boolean)">
|
1939
|
+
<summary>
|
1940
|
+
Returns all properties within a given type that have the specified attribute.
|
1941
|
+
</summary></member>
|
1942
|
+
<member name="M:KRPC.Utils.Reflection.GetAttribute``1(System.Reflection.MemberInfo)">
|
1943
|
+
<summary>
|
1944
|
+
Return attribute of type T for the given member. Does not follow inheritance.
|
1945
|
+
Throws ArgumentException if there is no attribute, or more than one attribute.
|
1946
|
+
</summary></member>
|
1947
|
+
<member name="M:KRPC.Utils.Reflection.HasAttribute``1(System.Reflection.MemberInfo)">
|
1948
|
+
<summary>
|
1949
|
+
Return true if member has the attribute of type T. Does not follow inheritance.
|
1950
|
+
</summary></member>
|
1951
|
+
<member name="M:KRPC.Utils.Reflection.IsStatic(System.Type)">
|
1952
|
+
<summary>
|
1953
|
+
Extension method to check if a type is static.
|
1954
|
+
</summary></member>
|
1955
|
+
<member name="M:KRPC.Utils.Reflection.IsStatic(System.Reflection.PropertyInfo)">
|
1956
|
+
<summary>
|
1957
|
+
Extension method to check if a property is static.
|
1958
|
+
</summary></member>
|
1959
|
+
<member name="M:KRPC.Utils.Reflection.IsPublic(System.Reflection.PropertyInfo)">
|
1960
|
+
<summary>
|
1961
|
+
Extension method to check if a property is public.
|
1962
|
+
</summary></member>
|
1963
|
+
<member name="T:KRPC.Utils.Tuple`1">
|
1964
|
+
<summary>
|
1965
|
+
A tuple with 1 elements
|
1966
|
+
</summary></member>
|
1967
|
+
<member name="P:KRPC.Utils.Tuple`1.Item1">
|
1968
|
+
<summary>
|
1969
|
+
Get/set the value of element 1
|
1970
|
+
</summary></member>
|
1971
|
+
<member name="M:KRPC.Utils.Tuple`1.#ctor(`0)">
|
1972
|
+
<summary>
|
1973
|
+
Create a tuple with the given values as its elements
|
1974
|
+
</summary></member>
|
1975
|
+
<member name="T:KRPC.Utils.Tuple`2">
|
1976
|
+
<summary>
|
1977
|
+
A tuple with 2 elements
|
1978
|
+
</summary></member>
|
1979
|
+
<member name="P:KRPC.Utils.Tuple`2.Item1">
|
1980
|
+
<summary>
|
1981
|
+
Get/set the value of element 2
|
1982
|
+
</summary></member>
|
1983
|
+
<member name="P:KRPC.Utils.Tuple`2.Item2">
|
1984
|
+
<summary>
|
1985
|
+
Get/set the value of element 2
|
1986
|
+
</summary></member>
|
1987
|
+
<member name="M:KRPC.Utils.Tuple`2.#ctor(`0,`1)">
|
1988
|
+
<summary>
|
1989
|
+
Create a tuple with the given values as its elements
|
1990
|
+
</summary></member>
|
1991
|
+
<member name="T:KRPC.Utils.Tuple`3">
|
1992
|
+
<summary>
|
1993
|
+
A tuple with 3 elements
|
1994
|
+
</summary></member>
|
1995
|
+
<member name="P:KRPC.Utils.Tuple`3.Item1">
|
1996
|
+
<summary>
|
1997
|
+
Get/set the value of element 3
|
1998
|
+
</summary></member>
|
1999
|
+
<member name="P:KRPC.Utils.Tuple`3.Item2">
|
2000
|
+
<summary>
|
2001
|
+
Get/set the value of element 3
|
2002
|
+
</summary></member>
|
2003
|
+
<member name="P:KRPC.Utils.Tuple`3.Item3">
|
2004
|
+
<summary>
|
2005
|
+
Get/set the value of element 3
|
2006
|
+
</summary></member>
|
2007
|
+
<member name="M:KRPC.Utils.Tuple`3.#ctor(`0,`1,`2)">
|
2008
|
+
<summary>
|
2009
|
+
Create a tuple with the given values as its elements
|
2010
|
+
</summary></member>
|
2011
|
+
<member name="T:KRPC.Utils.Tuple`4">
|
2012
|
+
<summary>
|
2013
|
+
A tuple with 4 elements
|
2014
|
+
</summary></member>
|
2015
|
+
<member name="P:KRPC.Utils.Tuple`4.Item1">
|
2016
|
+
<summary>
|
2017
|
+
Get/set the value of element 4
|
2018
|
+
</summary></member>
|
2019
|
+
<member name="P:KRPC.Utils.Tuple`4.Item2">
|
2020
|
+
<summary>
|
2021
|
+
Get/set the value of element 4
|
2022
|
+
</summary></member>
|
2023
|
+
<member name="P:KRPC.Utils.Tuple`4.Item3">
|
2024
|
+
<summary>
|
2025
|
+
Get/set the value of element 4
|
2026
|
+
</summary></member>
|
2027
|
+
<member name="P:KRPC.Utils.Tuple`4.Item4">
|
2028
|
+
<summary>
|
2029
|
+
Get/set the value of element 4
|
2030
|
+
</summary></member>
|
2031
|
+
<member name="M:KRPC.Utils.Tuple`4.#ctor(`0,`1,`2,`3)">
|
2032
|
+
<summary>
|
2033
|
+
Create a tuple with the given values as its elements
|
2034
|
+
</summary></member>
|
2035
|
+
<member name="T:KRPC.Utils.Tuple`5">
|
2036
|
+
<summary>
|
2037
|
+
A tuple with 5 elements
|
2038
|
+
</summary></member>
|
2039
|
+
<member name="P:KRPC.Utils.Tuple`5.Item1">
|
2040
|
+
<summary>
|
2041
|
+
Get/set the value of element 5
|
2042
|
+
</summary></member>
|
2043
|
+
<member name="P:KRPC.Utils.Tuple`5.Item2">
|
2044
|
+
<summary>
|
2045
|
+
Get/set the value of element 5
|
2046
|
+
</summary></member>
|
2047
|
+
<member name="P:KRPC.Utils.Tuple`5.Item3">
|
2048
|
+
<summary>
|
2049
|
+
Get/set the value of element 5
|
2050
|
+
</summary></member>
|
2051
|
+
<member name="P:KRPC.Utils.Tuple`5.Item4">
|
2052
|
+
<summary>
|
2053
|
+
Get/set the value of element 5
|
2054
|
+
</summary></member>
|
2055
|
+
<member name="P:KRPC.Utils.Tuple`5.Item5">
|
2056
|
+
<summary>
|
2057
|
+
Get/set the value of element 5
|
2058
|
+
</summary></member>
|
2059
|
+
<member name="M:KRPC.Utils.Tuple`5.#ctor(`0,`1,`2,`3,`4)">
|
2060
|
+
<summary>
|
2061
|
+
Create a tuple with the given values as its elements
|
2062
|
+
</summary></member>
|
2063
|
+
<member name="T:KRPC.Utils.Tuple`6">
|
2064
|
+
<summary>
|
2065
|
+
A tuple with 6 elements
|
2066
|
+
</summary></member>
|
2067
|
+
<member name="P:KRPC.Utils.Tuple`6.Item1">
|
2068
|
+
<summary>
|
2069
|
+
Get/set the value of element 6
|
2070
|
+
</summary></member>
|
2071
|
+
<member name="P:KRPC.Utils.Tuple`6.Item2">
|
2072
|
+
<summary>
|
2073
|
+
Get/set the value of element 6
|
2074
|
+
</summary></member>
|
2075
|
+
<member name="P:KRPC.Utils.Tuple`6.Item3">
|
2076
|
+
<summary>
|
2077
|
+
Get/set the value of element 6
|
2078
|
+
</summary></member>
|
2079
|
+
<member name="P:KRPC.Utils.Tuple`6.Item4">
|
2080
|
+
<summary>
|
2081
|
+
Get/set the value of element 6
|
2082
|
+
</summary></member>
|
2083
|
+
<member name="P:KRPC.Utils.Tuple`6.Item5">
|
2084
|
+
<summary>
|
2085
|
+
Get/set the value of element 6
|
2086
|
+
</summary></member>
|
2087
|
+
<member name="P:KRPC.Utils.Tuple`6.Item6">
|
2088
|
+
<summary>
|
2089
|
+
Get/set the value of element 6
|
2090
|
+
</summary></member>
|
2091
|
+
<member name="M:KRPC.Utils.Tuple`6.#ctor(`0,`1,`2,`3,`4,`5)">
|
2092
|
+
<summary>
|
2093
|
+
Create a tuple with the given values as its elements
|
2094
|
+
</summary></member>
|
2095
|
+
<member name="T:KRPC.Utils.Tuple`7">
|
2096
|
+
<summary>
|
2097
|
+
A tuple with 7 elements
|
2098
|
+
</summary></member>
|
2099
|
+
<member name="P:KRPC.Utils.Tuple`7.Item1">
|
2100
|
+
<summary>
|
2101
|
+
Get/set the value of element 7
|
2102
|
+
</summary></member>
|
2103
|
+
<member name="P:KRPC.Utils.Tuple`7.Item2">
|
2104
|
+
<summary>
|
2105
|
+
Get/set the value of element 7
|
2106
|
+
</summary></member>
|
2107
|
+
<member name="P:KRPC.Utils.Tuple`7.Item3">
|
2108
|
+
<summary>
|
2109
|
+
Get/set the value of element 7
|
2110
|
+
</summary></member>
|
2111
|
+
<member name="P:KRPC.Utils.Tuple`7.Item4">
|
2112
|
+
<summary>
|
2113
|
+
Get/set the value of element 7
|
2114
|
+
</summary></member>
|
2115
|
+
<member name="P:KRPC.Utils.Tuple`7.Item5">
|
2116
|
+
<summary>
|
2117
|
+
Get/set the value of element 7
|
2118
|
+
</summary></member>
|
2119
|
+
<member name="P:KRPC.Utils.Tuple`7.Item6">
|
2120
|
+
<summary>
|
2121
|
+
Get/set the value of element 7
|
2122
|
+
</summary></member>
|
2123
|
+
<member name="P:KRPC.Utils.Tuple`7.Item7">
|
2124
|
+
<summary>
|
2125
|
+
Get/set the value of element 7
|
2126
|
+
</summary></member>
|
2127
|
+
<member name="M:KRPC.Utils.Tuple`7.#ctor(`0,`1,`2,`3,`4,`5,`6)">
|
2128
|
+
<summary>
|
2129
|
+
Create a tuple with the given values as its elements
|
2130
|
+
</summary></member>
|
2131
|
+
<member name="T:KRPC.Utils.Tuple`8">
|
2132
|
+
<summary>
|
2133
|
+
A tuple with 8 elements
|
2134
|
+
</summary></member>
|
2135
|
+
<member name="P:KRPC.Utils.Tuple`8.Item1">
|
2136
|
+
<summary>
|
2137
|
+
Get/set the value of element 8
|
2138
|
+
</summary></member>
|
2139
|
+
<member name="P:KRPC.Utils.Tuple`8.Item2">
|
2140
|
+
<summary>
|
2141
|
+
Get/set the value of element 8
|
2142
|
+
</summary></member>
|
2143
|
+
<member name="P:KRPC.Utils.Tuple`8.Item3">
|
2144
|
+
<summary>
|
2145
|
+
Get/set the value of element 8
|
2146
|
+
</summary></member>
|
2147
|
+
<member name="P:KRPC.Utils.Tuple`8.Item4">
|
2148
|
+
<summary>
|
2149
|
+
Get/set the value of element 8
|
2150
|
+
</summary></member>
|
2151
|
+
<member name="P:KRPC.Utils.Tuple`8.Item5">
|
2152
|
+
<summary>
|
2153
|
+
Get/set the value of element 8
|
2154
|
+
</summary></member>
|
2155
|
+
<member name="P:KRPC.Utils.Tuple`8.Item6">
|
2156
|
+
<summary>
|
2157
|
+
Get/set the value of element 8
|
2158
|
+
</summary></member>
|
2159
|
+
<member name="P:KRPC.Utils.Tuple`8.Item7">
|
2160
|
+
<summary>
|
2161
|
+
Get/set the value of element 8
|
2162
|
+
</summary></member>
|
2163
|
+
<member name="P:KRPC.Utils.Tuple`8.Item8">
|
2164
|
+
<summary>
|
2165
|
+
Get/set the value of element 8
|
2166
|
+
</summary></member>
|
2167
|
+
<member name="M:KRPC.Utils.Tuple`8.#ctor(`0,`1,`2,`3,`4,`5,`6,`7)">
|
2168
|
+
<summary>
|
2169
|
+
Create a tuple with the given values as its elements
|
2170
|
+
</summary></member>
|
2171
|
+
<member name="T:KRPC.Utils.Tuple">
|
2172
|
+
<summary>
|
2173
|
+
Static functions for constructing tuples
|
2174
|
+
</summary></member>
|
2175
|
+
<member name="M:KRPC.Utils.Tuple.Create``1(``0)">
|
2176
|
+
<summary>
|
2177
|
+
Construct a tuple with 1 elements
|
2178
|
+
</summary></member>
|
2179
|
+
<member name="M:KRPC.Utils.Tuple.Create``2(``0,``1)">
|
2180
|
+
<summary>
|
2181
|
+
Construct a tuple with 2 elements
|
2182
|
+
</summary></member>
|
2183
|
+
<member name="M:KRPC.Utils.Tuple.Create``3(``0,``1,``2)">
|
2184
|
+
<summary>
|
2185
|
+
Construct a tuple with 3 elements
|
2186
|
+
</summary></member>
|
2187
|
+
<member name="M:KRPC.Utils.Tuple.Create``4(``0,``1,``2,``3)">
|
2188
|
+
<summary>
|
2189
|
+
Construct a tuple with 4 elements
|
2190
|
+
</summary></member>
|
2191
|
+
<member name="M:KRPC.Utils.Tuple.Create``5(``0,``1,``2,``3,``4)">
|
2192
|
+
<summary>
|
2193
|
+
Construct a tuple with 5 elements
|
2194
|
+
</summary></member>
|
2195
|
+
<member name="M:KRPC.Utils.Tuple.Create``6(``0,``1,``2,``3,``4,``5)">
|
2196
|
+
<summary>
|
2197
|
+
Construct a tuple with 6 elements
|
2198
|
+
</summary></member>
|
2199
|
+
<member name="M:KRPC.Utils.Tuple.Create``7(``0,``1,``2,``3,``4,``5,``6)">
|
2200
|
+
<summary>
|
2201
|
+
Construct a tuple with 7 elements
|
2202
|
+
</summary></member>
|
2203
|
+
<member name="M:KRPC.Utils.Tuple.Create``8(``0,``1,``2,``3,``4,``5,``6,``7)">
|
2204
|
+
<summary>
|
2205
|
+
Construct a tuple with 8 elements
|
2206
|
+
</summary></member>
|
2207
|
+
</members>
|
2208
|
+
</doc>
|