From c72222f7180c84e086d1e5f95432c587918f3195 Mon Sep 17 00:00:00 2001 From: Scott Ehlert Date: Wed, 14 Jul 2010 20:29:53 -0500 Subject: [PATCH] Updated docs on replicate and notify params for SetConVar* and ResetConVar (bug 4517, r=pred). --- plugins/include/console.inc | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/plugins/include/console.inc b/plugins/include/console.inc index a1482d68..ee40dc77 100644 --- a/plugins/include/console.inc +++ b/plugins/include/console.inc @@ -473,9 +473,8 @@ native bool:GetConVarBool(Handle:convar); /** * Sets the boolean value of a console variable. * - * Note: The replicate and notify params are ignored on the engines for Episode 2/Orange Box - * and Left 4 Dead. These engines automatically replicates and notifies as soon as the convar - * is changed. + * Note: The replicate and notify params are only relevant for the original, Dark Messiah, and + * Episode 1 engines. Newer engines automatically do these things when the convar value is changed. * * @param convar Handle to the convar. * @param value New boolean value. @@ -501,9 +500,8 @@ native GetConVarInt(Handle:convar); /** * Sets the integer value of a console variable. * - * Note: The replicate and notify params are ignored on the engines for Episode 2/Orange Box - * and Left 4 Dead. These engines automatically replicates and notifies as soon as the convar - * is changed. + * Note: The replicate and notify params are only relevant for the original, Dark Messiah, and + * Episode 1 engines. Newer engines automatically do these things when the convar value is changed. * * @param convar Handle to the convar. * @param value New integer value. @@ -529,9 +527,8 @@ native Float:GetConVarFloat(Handle:convar); /** * Sets the floating point value of a console variable. * - * Note: The replicate and notify params are ignored on the engines for Episode 2/Orange Box - * and Left 4 Dead. These engines automatically replicates and notifies as soon as the convar - * is changed. + * Note: The replicate and notify params are only relevant for the original, Dark Messiah, and + * Episode 1 engines. Newer engines automatically do these things when the convar value is changed. * * @param convar Handle to the convar. * @param value New floating point value. @@ -559,9 +556,8 @@ native GetConVarString(Handle:convar, String:value[], maxlength); /** * Sets the string value of a console variable. * - * Note: The replicate and notify params are ignored on the engines for Episode 2/Orange Box - * and Left 4 Dead. These engines automatically replicates and notifies as soon as the convar - * is changed. + * Note: The replicate and notify params are only relevant for the original, Dark Messiah, and + * Episode 1 engines. Newer engines automatically do these things when the convar value is changed. * * @param convar Handle to the convar. * @param value New string value. @@ -578,9 +574,8 @@ native SetConVarString(Handle:convar, const String:value[], bool:replicate=false /** * Resets the console variable to its default value. * - * Note: The replicate and notify params are ignored on the engines for Episode 2/Orange Box - * and Left 4 Dead. These engines automatically replicates and notifies as soon as the convar - * is changed. + * Note: The replicate and notify params are only relevant for the original, Dark Messiah, and + * Episode 1 engines. Newer engines automatically do these things when the convar value is changed. * * @param convar Handle to the convar. * @param replicate If set to true, the new convar value will be set on all clients.