SetTime: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 6: Line 6:


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|time|Float value between 0 to 24.}}
{{FuncParam|time|Float value between 0.0 and 24.0}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true'''.}}


== Example ==
== Example ==
<syntaxhighlight lang="Lua">
<syntaxhighlight lang="Lua>
code
-- server side
AddCommand("time", function(player, player_time)
if player_time == nil then
return AddPlayerChat(player, "Use /time <0-24>")
end
 
player_time = tonumber(player_time)
 
if player_time == nil or player_time < 0 or player_time > 24 then
return AddPlayerChat(player, "Parameter \"time\" value should be between 0-24")
end
 
CallRemoteEvent(player, "ClientSetTime", player_time)
end)
 
-- client side
AddRemoteEvent("ClientSetTime", function(time)
SetTime(time)
end)
</syntaxhighlight>
</syntaxhighlight>
Early morning:
[[File:LightingMorning.jpg|700px]]
Noon:
[[File:LightingNoon.jpg|700px]]
Evening:
[[File:LightingEvening.jpg|700px]]


{{RelatedFunctions}}
{{RelatedFunctions}}
* [[GetTime]]
* [[GetTime]]

Latest revision as of 09:46, 1 September 2020

SetTime

Type: Function
Context: Client
Introduced: v1.0

Description

Set the specified time for the client.

Syntax

SetTime(time)

Parameters

  • time
    Float value between 0.0 and 24.0

Return Value

  • Returns true.

Example

-- server side
AddCommand("time", function(player, player_time)
	if player_time == nil then
		return AddPlayerChat(player, "Use /time <0-24>")
	end

	player_time = tonumber(player_time)

	if player_time == nil or player_time < 0 or player_time > 24 then
		return AddPlayerChat(player, "Parameter \"time\" value should be between 0-24")
	end

	CallRemoteEvent(player, "ClientSetTime", player_time)
end)

-- client side
AddRemoteEvent("ClientSetTime", function(time)
	SetTime(time)
end)

Early morning:

Noon:

Evening:

See also