Garry's Mod Wiki

Home / timer.Simple

timer.Simple

  timer.Simple( number delay, function func )
Search Github

Description

Creates a simple timer that runs the given function after a specified delay.

For a more advanced version that you can control after creation, see timer.Create.

Timers use CurTime internally. Due to this, they won't advance while the client is timing out from the server or on an empty dedicated server due to hibernation. (unless sv_hibernate_think is set to 1).
A previous message on this page stated that a delay of 0 would run the function on the next tick. This was partially an invalid assumption, and the true behavior is dependent on where timer.Simple(0, func) is called relative to GarrysMod::Lua::Libraries::Timer::DoSimpleTimers.

  • If called before DoSimpleTimers, the callback will be executed on the same frame.

  • If called during DoSimpleTimers, the callback will be executed on the same frame. Note that calling timer.Simple(0, func) recursively (ie. a function that calls timer.simple(0, itself)) can lead to a hang!

  • If called after DoSimpleTimers, the callback will be executed on the next frame.

For more information on hook execution order, see Lua Hooks Order.

Arguments

1 number delay
How long until the function should be ran (in seconds). A value of 0 differs in behavior, depending on where you're calling this function.
2 function func
The function to run after the specified delay.

Example

Print Hello World after 5 seconds.

timer.Simple( 5, function() print( "Hello World" ) end )
Output:
Hello World

Example

Spawns 5 zombies and creates a timer.Simple that removes them in 11, 12, 13, 14, and 15 seconds.

for i = 1, 5 do local zombie = ents.Create( "npc_zombie" ) zombie:SetPos( Vector( i * 40, 0, 250 ) ) zombie:Spawn() timer.Simple( 10 + i, function() zombie:Remove() end ) end
Output:
-- 11 seconds into game 1st zombie disappears -- 12 seconds into game 2nd zombie disappears etc.

Account Management

Special Pages

Wiki List