Dota 2 Workshop Tools/Scripting/ThinkerFunctions: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(reorganized the page and added some details)
(added a small example)
Line 39: Line 39:
* Returning a number sets the next think time.  
* Returning a number sets the next think time.  
* Returning <code>nil</code> will unregister the thinker and stop it.
* Returning <code>nil</code> will unregister the thinker and stop it.
== Examples ==
=== Example 1 ===
Print a message to the console every 5 seconds:
<table>
<tr><th>Class method</th><th>Ordinary function</th></tr>
<tr>
<td valign="top">
<source lang="lua">
  -- 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
</source>
</td>
<td valign="top">
<source lang="lua">
-- scripts/vscripts/addon_game_mode.lua
function PrintHello ()
  print("Hello world!")
  return 5
end
function Activate ()
  GameRules:GetGameModeEntity():SetThink(PrintHello)
end
</source>
</td>
</tr>
</table>


{{shortpagetitle}}
{{shortpagetitle}}
[[Category:Dota 2 Workshop Tools]]
[[Category:Dota 2 Workshop Tools]]

Revision as of 01:39, 14 September 2014

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.pngTip: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 methodOrdinary 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
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Dota_2_Workshop_Tools/Scripting/ThinkerFunctions&oldid=187555"