Difference between revisions of "Osiris/API/AddEntryToCustomBook"
From Divinity Engine Wiki
(Documented AddEntryToCustomBook) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
* call '''AddEntryToCustomBook'''(''(STRING)'''''_Bookname''', ''(STRING)'''''_Entryname''') | * call '''AddEntryToCustomBook'''(''(STRING)'''''_Bookname''', ''(STRING)'''''_Entryname''') | ||
===== Description ===== | ===== Description ===== | ||
| − | If a custom book with the identifier '''_Bookname''' does not yet exist, internally creates a new "custom book" with that identifier. | + | If a custom book with the identifier '''_Bookname''' does not yet exist, this call internally creates a new "custom book" with that identifier. |
| − | Next, adds the text associated with the [[Translated_string_key_editor|translated string key]] '''_Entryname''' | + | Next, it adds the text associated with the [[Translated_string_key_editor|translated string key]] '''_Entryname''' after the existing text in '''_Bookname''' (if any). |
===== Notes ===== | ===== Notes ===== | ||
* '''_Bookname''' is an arbitrary identifier of your choice. It does not have to correspond to any in-game item or translated string. | * '''_Bookname''' is an arbitrary identifier of your choice. It does not have to correspond to any in-game item or translated string. | ||
| − | * If you try to add | + | * If you try to add the same translated string key multiple times to the same book, nothing will happen after the first time. |
===== See Also ===== | ===== See Also ===== | ||
*[[Osiris/API/OpenCustomBookUI|OpenCustomBookUI]] | *[[Osiris/API/OpenCustomBookUI|OpenCustomBookUI]] | ||
Latest revision as of 13:03, 9 October 2018
Full Definition(s)
- call AddEntryToCustomBook((STRING)_Bookname, (STRING)_Entryname)
Description
If a custom book with the identifier _Bookname does not yet exist, this call internally creates a new "custom book" with that identifier.
Next, it adds the text associated with the translated string key _Entryname after the existing text in _Bookname (if any).
Notes
- _Bookname is an arbitrary identifier of your choice. It does not have to correspond to any in-game item or translated string.
- If you try to add the same translated string key multiple times to the same book, nothing will happen after the first time.
