SaveNumber (Method): Difference between revisions

Latest revision as of 05:27, 27 April 2023

SaveNumber( string `key`, float `value` )
Returns	nil
Description:	Saves a number value that can be reloaded from any server via LoadNumber. The DataCost taken up by a saved number can be removed by saving 0 as the value.
Member of:	Player

This code would save the number 5 to the key "Number" when a player leaves:

game.Players.PlayerRemoving:connect(function(player)
	if player.DataReady then
		player:SaveNumber("Number", 5)
	end
end)

@@ Line 1: / Line 1: @@
-{{AdminOnly}}
+<onlyinclude>{{Method
-<onlyinclude>{{AdminOnlyMethod
 |name                 = SaveNumber
-|arguments            = [[String]] key, [[Number]] value
+|arguments            = {{type|string}} <var>key</var>, {{type|float}} <var>value</var>
-|description          = Saves a number value that can be reloaded from any server via [[LoadNumber (Method)|LoadNumber]]
+|description          = Saves a {{type|number}} value that can be reloaded from any server via [[LoadNumber (Method)|LoadNumber]].  The [[DataCost]] taken up by a saved {{type|number}} can be removed by saving ''0'' as the value.
 |object               = Player
-|returns              = [[nil]]
 }}</onlyinclude>
 {{clear floats}}
+==Example==
+This code would save the {{type|number}} 5 to the key "Number" when a player leaves:
+<syntaxhighlight lang="lua">
+game.Players.PlayerRemoving:connect(function(player)
+	if player.DataReady then
+		player:SaveNumber("Number", 5)
+	end
+end)
+</syntaxhighlight>
+==See Also==
+*[[File:Method Icon.png]] [[SaveBoolean (Method)|SaveBoolean]]
+*[[File:Method Icon.png]] [[SaveString (Method)|SaveString]]
+*[[File:Method Icon.png]] [[SaveInstance (Method)|SaveInstance]]
 [[Category:Methods]]