2022-01-15 12:33:23 +00:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
< html >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< head >
2023-07-20 12:13:57 +01:00
< title > TombEngine 1.1.0 Lua API< / title >
2022-01-15 12:33:23 +00:00
< link rel = "stylesheet" href = "../ldoc.css" type = "text/css" / >
< / head >
< body >
< div id = "container" >
< div id = "product" >
< div id = "product_logo" > < / div >
< div id = "product_name" > < big > < b > < / b > < / big > < / div >
< div id = "product_description" > < / div >
< / div > <!-- id="product" -->
< div id = "main" >
<!-- Menu -->
< div id = "navigation" >
< br / >
< h1 > TombEngine< / h1 >
< ul >
< li > < a href = "../index.html" > Index< / a > < / li >
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 1 Modules< / h2 >
2022-01-15 12:33:23 +00:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../1 modules/Effects.html" > Effects< / a > < / li >
< li > < a href = "../1 modules/Flow.html" > Flow< / a > < / li >
< li > < a href = "../1 modules/Inventory.html" > Inventory< / a > < / li >
< li > < a href = "../1 modules/Logic.html" > Logic< / a > < / li >
< li > < a href = "../1 modules/Misc.html" > Misc< / a > < / li >
< li > < a href = "../1 modules/Objects.html" > Objects< / a > < / li >
< li > < a href = "../1 modules/Strings.html" > Strings< / a > < / li >
2022-01-15 12:33:23 +00:00
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 2 Classes< / h2 >
2022-01-15 12:33:23 +00:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Flow.Animations.html" > Flow.Animations< / a > < / li >
< li > < a href = "../2 classes/Flow.Fog.html" > Flow.Fog< / a > < / li >
< li > < a href = "../2 classes/Flow.InventoryItem.html" > Flow.InventoryItem< / a > < / li >
< li > < a href = "../2 classes/Flow.Level.html" > Flow.Level< / a > < / li >
< li > < a href = "../2 classes/Flow.Mirror.html" > Flow.Mirror< / a > < / li >
< li > < a href = "../2 classes/Flow.Settings.html" > Flow.Settings< / a > < / li >
< li > < a href = "../2 classes/Flow.SkyLayer.html" > Flow.SkyLayer< / a > < / li >
< li > < a href = "../2 classes/Objects.AIObject.html" > Objects.AIObject< / a > < / li >
< li > < a href = "../2 classes/Objects.Camera.html" > Objects.Camera< / a > < / li >
< li > < a href = "../2 classes/Objects.LaraObject.html" > Objects.LaraObject< / a > < / li >
< li > < a href = "../2 classes/Objects.Moveable.html" > Objects.Moveable< / a > < / li >
2022-12-30 16:33:26 +00:00
< li > < a href = "../2 classes/Objects.Room.html" > Objects.Room< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Objects.Sink.html" > Objects.Sink< / a > < / li >
< li > < a href = "../2 classes/Objects.SoundSource.html" > Objects.SoundSource< / a > < / li >
< li > < a href = "../2 classes/Objects.Static.html" > Objects.Static< / a > < / li >
2022-12-16 18:36:42 +00:00
< li > < a href = "../2 classes/Objects.Volume.html" > Objects.Volume< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < here > Strings.DisplayString< / here > < / li >
2022-01-15 12:33:23 +00:00
< / ul >
2022-04-10 00:38:39 +01:00
< h2 > 3 Primitive Classes< / h2 >
2022-01-15 12:33:23 +00:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../3 primitive classes/Color.html" > Color< / a > < / li >
< li > < a href = "../3 primitive classes/Rotation.html" > Rotation< / a > < / li >
2023-05-31 21:48:00 +01:00
< li > < a href = "../3 primitive classes/Vec2.html" > Vec2< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../3 primitive classes/Vec3.html" > Vec3< / a > < / li >
2022-01-15 12:33:23 +00:00
< / ul >
2022-04-10 00:38:39 +01:00
< h2 > 4 Enums< / h2 >
2022-01-15 12:33:23 +00:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../4 enums/Effects.BlendID.html" > Effects.BlendID< / a > < / li >
< li > < a href = "../4 enums/Effects.EffectID.html" > Effects.EffectID< / a > < / li >
< li > < a href = "../4 enums/Misc.ActionID.html" > Misc.ActionID< / a > < / li >
2023-01-26 21:20:50 +00:00
< li > < a href = "../4 enums/Misc.CameraType.html" > Misc.CameraType< / a > < / li >
2023-05-31 21:48:00 +01:00
< li > < a href = "../4 enums/Misc.LogLevel.html" > Misc.LogLevel< / a > < / li >
2023-07-20 12:13:57 +01:00
< li > < a href = "../4 enums/Misc.SoundTrackType.html" > Misc.SoundTrackType< / a > < / li >
2023-09-28 19:20:04 +01:00
< li > < a href = "../4 enums/Objects.AmmoType.html" > Objects.AmmoType< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../4 enums/Objects.ObjID.html" > Objects.ObjID< / a > < / li >
2022-12-30 16:33:26 +00:00
< li > < a href = "../4 enums/Objects.RoomFlagID.html" > Objects.RoomFlagID< / a > < / li >
< li > < a href = "../4 enums/Objects.RoomReverb.html" > Objects.RoomReverb< / a > < / li >
2022-01-15 12:33:23 +00:00
< / ul >
2022-07-29 21:12:54 +01:00
< h2 > 5 Lua utility modules< / h2 >
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../5 lua utility modules/EventSequence.html" > EventSequence< / a > < / li >
< li > < a href = "../5 lua utility modules/Timer.html" > Timer< / a > < / li >
2022-07-29 21:12:54 +01:00
< / ul >
2022-01-15 12:33:23 +00:00
< / div >
< div id = "content" >
2022-04-10 00:38:39 +01:00
< h1 > Class < code > Strings.DisplayString< / code > < / h1 >
2022-01-15 12:33:23 +00:00
< p > A string appearing on the screen.< / p >
< p > Can be used for subtitles and "2001, somewhere in Egypt"-style messages.< / p >
< p > Uses screen-space coordinates, with x values specifying the number of pixels from the left of the window,
and y values specifying the number of pixels from the top of the window.< / p >
< p > Since different players will have different resolutions, you should work in terms of percentages where possible,
2022-04-10 00:38:39 +01:00
and use < a href = "../1 modules/Misc.html#ScreenToPercent" > ScreenToPercent< / a > and < a href = "../1 modules/Misc.html#PercentToScreen" > PercentToScreen< / a >
2022-01-15 12:33:23 +00:00
when you need to use screen-space coordinates.< / p >
2022-04-10 00:38:39 +01:00
< h2 > < a href = "#Functions" > Functions< / a > < / h2 >
2022-01-15 12:33:23 +00:00
< table class = "function_list" >
< tr >
2022-05-13 14:31:04 +01:00
< td class = "name" > < a href = "#DisplayString" > DisplayString(str, x, y, color, translated, flags)< / a > < / td >
2022-04-10 00:38:39 +01:00
< td class = "summary" > Create a DisplayString.< / td >
2022-01-15 12:33:23 +00:00
< / tr >
< tr >
2022-12-01 21:17:41 +00:00
< td class = "name" > < a href = "#DisplayString:GetColor" > DisplayString:GetColor()< / a > < / td >
2022-04-10 00:38:39 +01:00
< td class = "summary" > Get the display string's color< / td >
2022-01-15 12:33:23 +00:00
< / tr >
< tr >
2022-12-01 21:17:41 +00:00
< td class = "name" > < a href = "#DisplayString:SetColor" > DisplayString:SetColor(color)< / a > < / td >
2022-04-10 00:38:39 +01:00
< td class = "summary" > Set the display string's color< / td >
< / tr >
< tr >
2022-12-01 21:17:41 +00:00
< td class = "name" > < a href = "#DisplayString:GetKey" > DisplayString:GetKey()< / a > < / td >
< td class = "summary" > Get the string key to use.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#DisplayString:SetKey" > DisplayString:SetKey(string)< / a > < / td >
2022-04-10 00:38:39 +01:00
< td class = "summary" > Set the string key to use.< / td >
2022-01-15 12:33:23 +00:00
< / tr >
< tr >
2022-04-10 00:38:39 +01:00
< td class = "name" > < a href = "#DisplayString:SetPosition" > DisplayString:SetPosition(x, y)< / a > < / td >
2022-01-15 12:33:23 +00:00
< td class = "summary" > Set the position of the string.< / td >
< / tr >
< tr >
2022-04-10 00:38:39 +01:00
< td class = "name" > < a href = "#DisplayString:GetPosition" > DisplayString:GetPosition()< / a > < / td >
2022-01-15 12:33:23 +00:00
< td class = "summary" > Get the position of the string.< / td >
< / tr >
2023-04-11 21:29:59 +01:00
< tr >
< td class = "name" > < a href = "#DisplayString:SetFlags" > DisplayString:SetFlags(table)< / a > < / td >
< td class = "summary" > Set the display string's flags< / td >
< / tr >
2023-05-31 21:48:00 +01:00
< tr >
< td class = "name" > < a href = "#DisplayString:SetTranslated" > DisplayString:SetTranslated(shouldTranslate)< / a > < / td >
< td class = "summary" > Set translated parameter of the string< / td >
< / tr >
2022-01-15 12:33:23 +00:00
< / table >
< br / >
< br / >
< h2 class = "section-header " > < a name = "Functions" > < / a > Functions< / h2 >
< dl class = "function" >
< dt >
2022-05-13 14:31:04 +01:00
< a name = "DisplayString" > < / a >
< strong > DisplayString(str, x, y, color, translated, flags)< / strong >
2022-01-15 12:33:23 +00:00
< / dt >
< dd >
Create a DisplayString.
2022-04-10 00:38:39 +01:00
For use in < a href = "../1 modules/Strings.html#ShowString" > ShowString< / a > and < a href = "../1 modules/Strings.html#HideString" > HideString< / a > .
2022-01-15 12:33:23 +00:00
2022-12-09 22:08:16 +00:00
2022-01-15 12:33:23 +00:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > str< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-01-15 12:33:23 +00:00
string to print or key of translated string
< / li >
< li > < span class = "parameter" > x< / span >
< span class = "types" > < span class = "type" > int< / span > < / span >
x-coordinate of top-left of string (or the center if DisplayStringOption.CENTER is given)
< / li >
< li > < span class = "parameter" > y< / span >
< span class = "types" > < span class = "type" > int< / span > < / span >
y-coordinate of top-left of string (or the center if DisplayStringOption.CENTER is given)
< / li >
< li > < span class = "parameter" > color< / span >
2022-12-11 18:40:31 +00:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Color.html#" > Color< / a > < / span >
2022-01-15 12:33:23 +00:00
the color of the text
< / li >
2022-04-10 12:01:20 +01:00
< li > < span class = "parameter" > translated< / span >
< span class = "types" > < span class = "type" > bool< / span > < / span >
if false or omitted, the str argument will be printed.
If true, the str argument will be the key of a translated string specified in
strings.lua. < strong > Default: false< / strong > .
< / li >
2022-01-15 12:33:23 +00:00
< li > < span class = "parameter" > flags< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.6" > table< / a > < / span >
2022-01-15 12:33:23 +00:00
a table of display options. Can be empty or omitted. The possible values and their effects are...< / p >
2022-04-10 00:38:39 +01:00
< pre > < code > TEN.Strings.DisplayStringOption.CENTER -- see x and y parameters
TEN.Strings.DisplayStringOption.SHADOW -- will give the text a small shadow
2022-01-15 12:33:23 +00:00
< / code > < / pre >
< p > < strong > Default: empty< / strong >
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
2022-12-01 21:17:41 +00:00
< span class = "types" > < a class = "type" href = "../2 classes/Strings.DisplayString.html#DisplayString" > DisplayString< / a > < / span >
2022-01-15 12:33:23 +00:00
A new DisplayString object.
< / ol >
< / dd >
< dt >
2022-12-01 21:17:41 +00:00
< a name = "DisplayString:GetColor" > < / a >
< strong > DisplayString:GetColor()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
Get the display string's color
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Returns:< / h3 >
< ol >
2022-12-11 18:40:31 +00:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Color.html#" > Color< / a > < / span >
2022-04-10 00:38:39 +01:00
a copy of the display string's color
< / ol >
< / dd >
< dt >
2022-12-01 21:17:41 +00:00
< a name = "DisplayString:SetColor" > < / a >
< strong > DisplayString:SetColor(color)< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
Set the display string's color
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > color< / span >
2022-12-11 18:40:31 +00:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Color.html#" > Color< / a > < / span >
2022-04-10 00:38:39 +01:00
the new color of the display string
< / li >
< / ul >
< / dd >
< dt >
2022-12-01 21:17:41 +00:00
< a name = "DisplayString:GetKey" > < / a >
< strong > DisplayString:GetKey()< / strong >
< / dt >
< dd >
Get the string key to use. If < code > translated< / code > is true when < a href = "../2 classes/Strings.DisplayString.html#DisplayString" > DisplayString< / a >
is called, this will be the string key for the translation that will be displayed.
If false or omitted, this will be the string that's displayed.
2022-12-09 22:08:16 +00:00
2022-12-01 21:17:41 +00:00
< h3 > Returns:< / h3 >
< ol >
2023-04-11 21:29:59 +01:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-12-01 21:17:41 +00:00
a string
< / ol >
< / dd >
< dt >
< a name = "DisplayString:SetKey" > < / a >
< strong > DisplayString:SetKey(string)< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2022-05-13 14:31:04 +01:00
Set the string key to use. If < code > translated< / code > is true when < a href = "../2 classes/Strings.DisplayString.html#DisplayString" > DisplayString< / a >
2022-04-10 00:38:39 +01:00
is called, this will be the string key for the translation that will be displayed.
If false or omitted, this will be the string that's displayed.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > string< / span >
2023-04-11 21:29:59 +01:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the new key for the display string
< / li >
< / ul >
< / dd >
< dt >
< a name = "DisplayString:SetPosition" > < / a >
< strong > DisplayString:SetPosition(x, y)< / strong >
2022-01-15 12:33:23 +00:00
< / dt >
< dd >
Set the position of the string.
Screen-space coordinates are expected.
2022-12-09 22:08:16 +00:00
2022-01-15 12:33:23 +00:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > x< / span >
< span class = "types" > < span class = "type" > int< / span > < / span >
x-coordinate of the string
< / li >
< li > < span class = "parameter" > y< / span >
< span class = "types" > < span class = "type" > int< / span > < / span >
y-coordinate of the string
< / li >
< / ul >
< / dd >
< dt >
2022-04-10 00:38:39 +01:00
< a name = "DisplayString:GetPosition" > < / a >
< strong > DisplayString:GetPosition()< / strong >
2022-01-15 12:33:23 +00:00
< / dt >
< dd >
Get the position of the string.
Screen-space coordinates are returned.
2022-12-09 22:08:16 +00:00
2022-01-15 12:33:23 +00:00
< h3 > Returns:< / h3 >
< ol >
< li >
< span class = "types" > < span class = "type" > int< / span > < / span >
x x-coordinate of the string< / li >
< li >
< span class = "types" > < span class = "type" > int< / span > < / span >
y y-coordinate of the string< / li >
< / ol >
2023-04-11 21:29:59 +01:00
< / dd >
< dt >
< a name = "DisplayString:SetFlags" > < / a >
< strong > DisplayString:SetFlags(table)< / strong >
< / dt >
< dd >
Set the display string's flags
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > table< / span >
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.6" > table< / a > < / span >
the new table with display flags options
< / li >
< / ul >
< h3 > Usage:< / h3 >
< ul >
< pre class = "example" > < span class = "keyword" > local< / span > varDisplayString = DisplayString(< span class = "string" > 'example string'< / span > , < span class = "number" > 0< / span > , < span class = "number" > 0< / span > , Color(< span class = "number" > 255< / span > , < span class = "number" > 255< / span > , < span class = "number" > 255< / span > ), < span class = "keyword" > false< / span > )
2023-05-31 21:48:00 +01:00
possible values:
2023-04-11 21:29:59 +01:00
varDisplayString:SetFlags({})
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW })
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.CENTER })
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW, TEN.Strings.DisplayStringOption.CENTER })
< span class = "comment" > -- When passing a table to a function, you can omit the parentheses
< / span > varDisplayString:SetFlags{ TEN.Strings.DisplayStringOption.CENTER }< / pre >
< / ul >
2023-05-31 21:48:00 +01:00
< / dd >
< dt >
< a name = "DisplayString:SetTranslated" > < / a >
< strong > DisplayString:SetTranslated(shouldTranslate)< / strong >
< / dt >
< dd >
Set translated parameter of the string
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > shouldTranslate< / span >
< span class = "types" > < span class = "type" > bool< / span > < / span >
2023-06-03 11:44:57 +01:00
if true, the string's key will be used as the key for the translation that will be displayed.
If false, the key itself will be displayed
2023-05-31 21:48:00 +01:00
< / li >
< / ul >
2022-01-15 12:33:23 +00:00
< / dd >
< / dl >
< / div > <!-- id="content" -->
< / div > <!-- id="main" -->
< div id = "about" >
2023-03-31 20:51:44 +01:00
< i > generated by < a href = "https://github.com/hispidence/TEN-LDoc" > TEN-LDoc< / a > (a fork of < a href = "http://github.com/stevedonovan/LDoc" > LDoc 1.4.6< / a > )< / i >
2023-09-28 19:20:04 +01:00
< i style = "float:right;" > Last updated 2023-09-14 15:59:44 < / i >
2022-01-15 12:33:23 +00:00
< / div > <!-- id="about" -->
< / div > <!-- id="container" -->
< / body >
< / html >
