3e. In built Variables - HafisCZ/sf-tools GitHub Wiki
Recommend using log(<Name>)
and checking the browser console to access the nature for each of the entries bellow:
Name | Type | Description | Context |
---|---|---|---|
undefined | Entitie | Appears whenever the result of an expression is not defined (leads nowhere). Appears as a '?' in most cases. | Global |
null | Entitie | Element exists contains a void value/no value but isn't undefined | Global |
player | Object | Contains the current player object. | Local |
reference | Object | Contains the reference/compare player object. | Local |
joined | Array | List of names of the members that joined the guild in between the captures | Group |
kicked | Array | List of names of the chars that are no longer in the guild since reference capture | Group |
true | Boolean | Boolean true. Can result from an evaluated expression. | Global |
false | Boolean | Boolean false. Can result from an evaluated expression. | Global |
index | Number | Index in the grouped header iteration (to be used in the header expressions) | Grouped Header |
database | Object | Whole database object | Table |
row_index | Number | Row index upon table generation. Doesn't change with sort. | Local |
classes | Object | Class/Class Count pairs for guild members | Group |
header | Object | Contains the current header properties. | Local |
entries | Object | Contains the player objects for every capture for that given player | Local1 |
loop_index | Number | Index of iteration in the loop function.2 | Loop |
loop_array | Array | Array over which we are iterating in the loop function.2 | Loop |
table_timestamp | Number# | Current timestamp (datetime you choose from the dropdown above table) | Table |
table_reference | Number# | Reference timestamp (datetime you choose from the dropdown above table) | Table |
table_array | Array | Contains the pair player/reference objects for every non-discarded player. | Table |
table_array_unfiltered | Array | Contains the pair player/reference objects for every player regardless of discard. | Table |
Contexts:
Global - Every
Table - Capture dependent expressions
Local - Player object dependent expressions (like header and local variables)
Group - Only in Guilds
tab table at a Table context
Grouped Header - Only for the grouped header properties expressions
Loop - Only on the right argument of loop functions ( like each()
and map()
).
1 Also shows Own char Entries for upper table context ( like show as and table variables).
2 Example:
show a as map( [2,3,5] , loop_index*this)
show b as map( [2,3,5] , each(loop_array,this)*this)