A entry (such as a ItemType
) or an object containing the entry & a string for if the object has been renamed.
Optional
article: ArticleWhether to include an article in front of the name, ie in English, "a/an/the". Follows article rules for the current language.
"indefinite"
is only for single items, "a/an", and will be skipped if a count greater than that is provided."definite"
is for any number of items, and adds "the" to the start."title"
uses "indefinite"
if the user hasn't opted out of articles in object titles, and uses false
otherwise.false
to use no article.The dictionary this entry is a part of. For instance, Dictionary.Item
for ItemType
s.
A entry (such as a ItemType
) or an object containing the entry & a string for if the object has been renamed.
Optional
count: numberThe number of "things" we need the name of. For instance, if we're translating ItemType.Rock
, and we give 2
, it would return "rocks". (Auto pluralization)
Optional
article: ArticleWhether to include an article in front of the name, ie in English, "a/an/the". Follows article rules for the current language.
"indefinite"
is only for single items, "a/an", and will be skipped if a count greater than that is provided."definite"
is for any number of items, and adds "the" to the start."title"
uses "indefinite"
if the user hasn't opted out of articles in object titles, and uses false
otherwise.false
to use no article.Optional
showRenamedQuotes: booleanIf true
, show the (by default) "" quotes surrounding renamed items or entities.
Generated using TypeDoc
The dictionary this entry is a part of. For instance,
Dictionary.Item
forItemType
s.