tableImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function tableImage== Gets the image asset value from the specified Table. If the row is not specified then the default Macros:roll for the Table is used. The row can be ei...)
 
No edit summary
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Function tableImage==
{{MacroFunction
|name=tableImage
|version=1.3b40
|description=
Gets the image asset value from the specified [[Table|table]]. If the roll is not specified then the default [[Roll|roll]] for the [[Table|table]] is used.


Gets the image asset value from the specified [[Table]]. If the row is not specified then the default [[Macros:roll|roll]] for the [[Table]] is used. The row can be either a constant or a [[Macros:roll|roll]].
|usage=
<syntaxhighlight lang="mtmacro" line>
tableImage(name)
tableImage(name, roll)
tableImage(name, roll, size)
tblImage(name)
tblImage(name, roll)
tblImage(name, roll, size)
</syntaxhighlight>
'''Parameters'''
* {{code|name}} - A string containing the name of the [[Table|table]].
* {{code|row}} - The entry of the [[Table|table]] that should have the image asset returned.
* {{code|size}} - The size the image asset returned should be. If the image is not square, this will be the size of the height.


===Usage===
|examples=
<source lang="mtmacro" line>
'''Example 1:''' Display a random image from [[Table|table]] {{code|"tbl1"}} using default [[Roll|roll]]:
    [h: tableImage(tableName)]
<syntaxhighlight lang="mtmacro" line>
    [h: tableImage(tableName, row)]
<image src='[r: tableImage("tbl1")]'></image>
    [h: tableImage(tableName, row, size)]
</syntaxhighlight>
</source>
===Examples===
Display a random image from table "tbl1" using default roll.
<source lang="mtmacro" line>
    <image src='[r: tableImage("tbl1")]'></image>
</source>


Display the first image from table "tbl1".
'''Example 1:''' Display the first image from [[Table|table]] {{code|"tbl1"}}:
<source lang="mtmacro" line>
<syntaxhighlight  lang="mtmacro" line>
    <image src='[r: tableImage("tbl1", 1)]'></image>
<image src='[r: tableImage("tbl1", 1)]'></image>
</source>
</syntaxhighlight>


Display one of the first 4 images resized to 40 pixels high from "tbl1" chosed randomly. >
'''Example 2:''' Display one of the first four images, resized to {{code|40}} pixels tall, from {{code|"tbl1"}}, chosed randomly:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
    <image src='[r: tableImage("tbl1", "1d4", 40)]'></image>
<image src='[r: tableImage("tbl1", "1d4", 40)]'></image>
</source>
</syntaxhighlight>
<i>'''Note:''' In these examples, an image is sent into the chat. When sending multiple images to chat, a rendering issue can occur where images are not fully displayed until the chat panel is updated. Adding a {{code|width}} attribute to your {{code|image}} or {{code|img}} tags can work around this issue if you are experiencing it.</i>
 
|also=
{{func|table}}
}}
[[Category:Table Function]]

Latest revision as of 23:59, 15 July 2024

tableImage() Function

Introduced in version 1.3b40
Gets the image asset value from the specified table. If the roll is not specified then the default roll for the table is used.

Usage

tableImage(name)
tableImage(name, roll)
tableImage(name, roll, size)
tblImage(name)
tblImage(name, roll)
tblImage(name, roll, size)

Parameters

  • name - A string containing the name of the table.
  • row - The entry of the table that should have the image asset returned.
  • size - The size the image asset returned should be. If the image is not square, this will be the size of the height.

Examples

Example 1: Display a random image from table "tbl1" using default roll:
<image src='[r: tableImage("tbl1")]'></image>

Example 1: Display the first image from table "tbl1":

<image src='[r: tableImage("tbl1", 1)]'></image>

Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:

<image src='[r: tableImage("tbl1", "1d4", 40)]'></image>
Note: In these examples, an image is sent into the chat. When sending multiple images to chat, a rendering issue can occur where images are not fully displayed until the chat panel is updated. Adding a width attribute to your image or img tags can work around this issue if you are experiencing it.

See Also