diff options
Diffstat (limited to 'lib/sampling/README.md')
| -rw-r--r-- | lib/sampling/README.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lib/sampling/README.md b/lib/sampling/README.md index 731f1d1..bde84cd 100644 --- a/lib/sampling/README.md +++ b/lib/sampling/README.md @@ -9,6 +9,12 @@ interface: Returns whether or not this sampling method works with the specified game. + - `can_get?(User, String setting_name) => Fixnum` + + Returns whether or nat this sampling method can get a specifed + statistic; 0 means 'false', positive integers mean 'true', where + higher numbers are higher priority. + - `uses_remote?() => Boolean` Return whether or not this sampling method requires remote IDs for @@ -22,15 +28,10 @@ interface: When given an object from `RemoteUsername#value`, give back a human-readable/editable name to display. - - `sampling_start(Match)` + - `sampling_start(Match, Array[]={:user=>User,:stat=>String})` Fetch the statistics for a match. - - `sampling_done?(Match) => Boolean` - - Returns whether or not statistics have been completely collected - yet. - - `render_user_interaction(Match, User) => String` Returns HTML to render on a page. |