User Tools

Site Tools


crpl:docs:getcoreswithvar

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Last revisionBoth sides next revision
crpl:docs:getcoreswithvar [2013/01/14 14:01] – created chanicrpl:docs:getcoreswithvar [2020/05/30 20:13] – Fixed notation to be consistent with GetUnitsInRange and other GetUnit functions Sanian
Line 1: Line 1:
-TODO+~~DISCUSSION~~ 
 +<- [[crpl:crplreference| CRPL reference]] <- [[crpl:crplreference#unit_commands|Unit Commands]] 
 +=====  GetCoresWithVar  ===== 
 + 
 +^Arguments^Result^Notation^ 
 +| VariableName, Value | List of unit uids, amount of units |'' s1 d1 -- l1 l2...ln n''
 + 
 + 
 +=== Description === 
 +Searches across all CRPLCore units looking for any that have a script that contains the specified variable with the specified value.  Useful for finding units by name, or other value. The function pushes the n UID's onto the stack followed by the integer n, where n is the number of units.  
 + 
 +Note that a single core can have multiple scripts assigning VariableName to different values, any of which can be used to find the core. 
 + 
 +=== Examples === 
 + 
 +<code> 
 +"UnitName" "Item1" GetCoresWithVar 
 +0 do 
 +   ->unit 
 +   <-unit trace 
 +loop  
 + 
 + 
 +</code> 
crpl/docs/getcoreswithvar.txt · Last modified: 2021/02/05 11:43 by Karsten75