9
9
<refname>gnome-score</refname>
10
10
<refpurpose>Tracking best scores for games</refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
13
<refsynopsisdiv id="libgnome-gnome-score.synopsis" role="synopsis">
59
58
<title role="details.title">Details</title>
60
59
<refsect2 id="gnome-score-init" role="function" condition="deprecated:">
61
60
<title>gnome_score_init ()</title>
62
<indexterm zone="gnome-score-init" role="deprecated"><primary>gnome_score_init</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_score_init (const <link linkend="gchar">gchar</link> *gamename);</programlisting>
61
<indexterm zone="gnome-score-init" role="deprecated"><primary sortas="gnome_score_init">gnome_score_init</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_score_init (const <link linkend="gchar">gchar</link> *gamename);</programlisting>
63
62
<warning><para><literal>gnome_score_init</literal> is deprecated and should not be used in newly-written code.</para></warning>
65
64
GNOME games should call this routine as the first statement
67
66
performs the intialization required to later record information in the
68
67
scores table and then drops the groups privileges.</para>
71
69
</para><variablelist role="params">
72
<varlistentry><term><parameter>gamename</parameter> :</term>
70
<varlistentry><term><parameter>gamename</parameter> :</term>
73
71
<listitem><simpara> Identifies the game name.
74
72
</simpara></listitem></varlistentry>
75
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="0:CAPS"><literal>0</literal></link> on success, returns <link linkend="1:CAPS"><literal>-1</literal></link> on failure.
73
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="0--CAPS"><literal>0</literal></link> on success, returns <link linkend="1--CAPS"><literal>-1</literal></link> on failure.
76
74
</simpara></listitem></varlistentry>
77
75
</variablelist></refsect2>
78
76
<refsect2 id="gnome-score-log" role="function" condition="deprecated:">
79
77
<title>gnome_score_log ()</title>
80
<indexterm zone="gnome-score-log" role="deprecated"><primary>gnome_score_log</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_score_log (<link linkend="gfloat">gfloat</link> score,
78
<indexterm zone="gnome-score-log" role="deprecated"><primary sortas="gnome_score_log">gnome_score_log</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_score_log (<link linkend="gfloat">gfloat</link> score,
81
79
const <link linkend="gchar">gchar</link> *level,
82
80
<link linkend="gboolean">gboolean</link> higher_to_lower_score_order);</programlisting>
83
81
<warning><para><literal>gnome_score_log</literal> is deprecated and should not be used in newly-written code.</para></warning>
86
84
ends. This function takes care of working out whether the user's score made
87
85
it into the ten best scores and, if so, records it in the table.</para>
90
87
</para><variablelist role="params">
91
<varlistentry><term><parameter>score</parameter> :</term>
88
<varlistentry><term><parameter>score</parameter> :</term>
92
89
<listitem><simpara> The score achieved by the user in this game
93
90
</simpara></listitem></varlistentry>
94
<varlistentry><term><parameter>level</parameter> :</term>
91
<varlistentry><term><parameter>level</parameter> :</term>
95
92
<listitem><simpara> The level on which the score was obtained
96
93
</simpara></listitem></varlistentry>
97
<varlistentry><term><parameter>higher_to_lower_score_order</parameter> :</term>
98
<listitem><simpara> Set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if high scores are better than
94
<varlistentry><term><parameter>higher_to_lower_score_order</parameter> :</term>
95
<listitem><simpara> Set to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if high scores are better than
100
97
</simpara></listitem></varlistentry>
101
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="0:CAPS"><literal>0</literal></link> on failure and the number of bytes written otherwise.
98
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="0--CAPS"><literal>0</literal></link> on failure and the number of bytes written otherwise.
102
99
</simpara></listitem></varlistentry>
103
100
</variablelist></refsect2>
104
101
<refsect2 id="gnome-score-get-notable" role="function" condition="deprecated:">
105
102
<title>gnome_score_get_notable ()</title>
106
<indexterm zone="gnome-score-get-notable" role="deprecated"><primary>gnome_score_get_notable</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_score_get_notable (const <link linkend="gchar">gchar</link> *gamename,
103
<indexterm zone="gnome-score-get-notable" role="deprecated"><primary sortas="gnome_score_get_notable">gnome_score_get_notable</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_score_get_notable (const <link linkend="gchar">gchar</link> *gamename,
107
104
const <link linkend="gchar">gchar</link> *level,
108
105
<link linkend="gchar">gchar</link> ***names,
109
106
<link linkend="gfloat">gfloat</link> **scores,
113
110
Fetches the most notable players on <parameter>gamename</parameter> at level <parameter>level</parameter>.</para>
116
112
</para><variablelist role="params">
117
<varlistentry><term><parameter>gamename</parameter> :</term>
113
<varlistentry><term><parameter>gamename</parameter> :</term>
118
114
<listitem><simpara> The name of the game we want to fetch information from.
119
115
</simpara></listitem></varlistentry>
120
<varlistentry><term><parameter>level</parameter> :</term>
116
<varlistentry><term><parameter>level</parameter> :</term>
121
117
<listitem><simpara> The level for which we want to pull information.
122
118
</simpara></listitem></varlistentry>
123
<varlistentry><term><parameter>names</parameter> :</term>
119
<varlistentry><term><parameter>names</parameter> :</term>
124
120
<listitem><simpara> An array of strings is returned at the address pointed here
125
121
</simpara></listitem></varlistentry>
126
<varlistentry><term><parameter>scores</parameter> :</term>
122
<varlistentry><term><parameter>scores</parameter> :</term>
127
123
<listitem><simpara> An array of gfloats is returned at the address pointed here
128
124
</simpara></listitem></varlistentry>
129
<varlistentry><term><parameter>scoretimes</parameter> :</term>
125
<varlistentry><term><parameter>scoretimes</parameter> :</term>
130
126
<listitem><simpara> An array of time_t is returned at the address pointed here
131
127
</simpara></listitem></varlistentry>
132
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of scores returned. The <parameter>names</parameter>, <parameter>scores</parameter> and <parameter>scoretime</parameter>
128
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of scores returned. The <parameter>names</parameter>, <parameter>scores</parameter> and <parameter>scoretime</parameter>
133
129
pointers point to regions that were allocated with <link linkend="g-malloc"><function>g_malloc()</function></link> with the
135
131
</simpara></listitem></varlistentry>
added
removed
doc/reference/xml/gnome-score.xml
