v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

User:Sphr/f

From Dwarf Fortress Wiki
Jump to navigation Jump to search

template function test

If any "function call" results in an undefined wikipage, it means the implementation for that value is still missing.


inc

User:Sphr/f/inc

{{:Sphr/f/inc|x}} where x is a number gives value of x+1 if implemented.

implementation

dec

User:Sphr/f/dec

{{:Sphr/f/dec|x}} where x is a number gives value of x-1 if implemented.

implementation

add

User:Sphr/f/add

{{:Sphr/f/add|x|y}} where x,y are numbers gives value of x+y if implemented.

implementation


User:Sphr/f/minus

{{:Sphr/f/minus|x|y}} where x,y are numbers gives value of y-x if implemented.

implementation

mult

User:Sphr/f/mult

{{:Sphr/f/mult|x|y}} where x,y are numbers gives value of x*y if implemented.

implementation

1d array

Format:

{{User:Sphr/f/array1_elem | {{{1}}} | num-elements | data ... }}

Used to define a 1d-array-data-page.

To prepare the data template, create a new page and use the above format for the content.

E.g.: Suppose I create a data page named "MyArray" of 9 elements with content : a,b,c,d,e,f,g,h,i

 {{ User:Sphr/f/array1_elem | {{{1}}} |9|a|b|c|d|e|f|g|h|i}}

To use, just include the data page as a template with the desired element index (beware, no range checking!!!!)

E.g.: The following shows some template calls for this example and the corresponding results

Template call Result
{{:MyArray|1}} a
{{:MyArray|2}} b
{{:MyArray|3}} c
{{:MyArray|4}} d
{{:MyArray|5}} e
{{:MyArray|6}} f
{{:MyArray|7}} g
{{:MyArray|8}} h
{{:MyArray|9}} i
{{:User:Sphr/f/array1_size | :MyArray }} 9

Gets the size defined in the 1d-array-data-page.

E.g.: The following retrieves the size of MyArray example defined above, which is 9.

2d array

Format:

{{User:Sphr/f/array2_elem | {{{1}}} | {{{2}}} | num-rows | num-cols | data ... }}

Used to define a 2d array-data-page

To prepare the data page, create a new page and use the above format for the content.

E.g.: Suppose I create a data page named "MyArray2" of 3x3 elements with the element at row y and col x as "rycx".

 {{ User:Sphr/f/array2_elem|{{{1}}}|{{{2}}}|3|3|r1c1|r1c2|r1c3|r2c1|r2c2|r2c3|r3c1|r3c2|r3c3 }}

E.g.: The following shows some template calls for this example and the corresponding results

Template call Result
{{:MyArray2|1|1}} r1c1
{{:MyArray2|1|2}} r1c2
{{:MyArray2|1|3}} r1c3
{{:MyArray2|2|1}} r2c1
{{:MyArray2|2|2}} r2c2
{{:MyArray2|2|3}} r2c3
{{:MyArray2|3|1}} r3c1
{{:MyArray2|3|2}} r3c2
{{:MyArray2|3|3}} r3c3
{{:User:Sphr/f/array2_size1 | :MyArray2 }} 3
{{:User:Sphr/f/array2_size2 | :MyArray2 }} 3


Gets number of rows defined in the 2d-array-data-page

Gets number of cols defined in the 2d-array-data-page

Used internally to computes internal index