ThinkerFunctions

Template:Otherlang2 The SetThink function can be used to

run a function every x seconds,
schedule a function to be run x seconds from now.

Passing a function to SetThink is called "registering a think function". It is possible to have multiple think functions running on an entity at the same time, but this does require the think functions to be named so as not to overlap.

Tip:The source code for SetThink can be found here: /path/to/Steam/SteamApps/common/dota 2 beta/dota/scripts/vscripts/utils/vscriptinit.lua

Signature

SetThink is a method on the CBaseEntity class. It can be used in two ways:

void SetThink(function thinkFn, string thinkName, float initialDelay)

thinkFn: The function that you want to run.

The other two arguments are optional:

thinkName: The name of the think slot. Use this if you want to register multiple thinkers on the same entity.
initialDelay: Delay in seconds before the thinker should start.

void SetThink(string thinkFnName, table context, string thinkName, float initialDelay)

thinkFnName: The name of the function you want to run.
context: A table/object. The function that will be registered is context[thinkFnName]. In other words, SetThink uses the first argument as an index into the second argument.
thinkName, initialDelay: These are optional. Their descriptions are as above.

Your function should return a number or nil:

Returning a number sets the next think time.
Returning nil will unregister the thinker and stop it.

Examples

Example 1

Print a message to the console every 5 seconds:

Class method

Ordinary function

  -- scripts/vscripts/addon_game_mode.lua
 
 if CustomGameMode == nil then
   CustomGameMode = class({})
 end
 
 function CustomGameMode:PrintHello ()
   print("Hello world!")
   return 5
 end
 
 function CustomGameMode:InitGameMode ()
   GameRules:GetGameModeEntity():SetThink("PrintHello", self)
 end
 
 function Activate ()
   GameRules.CustomAddon = CustomGameMode()
   GameRules.CustomAddon:InitGameMode()
 end

 -- scripts/vscripts/addon_game_mode.lua

 function PrintHello ()
   print("Hello world!")
   return 5
 end

 function Activate ()
   GameRules:GetGameModeEntity():SetThink(PrintHello)
 end

ThinkerFunctions

Signature

Examples

Example 1

Navigation menu

Search