Conversation
Benjamin-Dobell
left a comment
There was a problem hiding this comment.
Great work, there's a lot of stuff here! Mostly just nitpicks.
|
https://steamcommunity.com/app/286160/eventcomments/1634166237645750353?ctp=4#c1637542851352346026 They're |
| - 'RPGFigurine': rpgfigurine.md | ||
| - 'TextTool': texttool.md | ||
| - 'Time': time.md | ||
| - 'Timer': timer.md |
There was a problem hiding this comment.
Should we keep or not the Timer doc ?
@Benjamin-Dobell
There was a problem hiding this comment.
I think it's reasonable to remove it. Having two options is confusing for newbies and they may not realise that Wait is a better solution.
There was a problem hiding this comment.
it's already gone from the nav bar on the main website
There was a problem hiding this comment.
it's deprecated but it still works, so i don't think we should
There was a problem hiding this comment.
That's fair. Maybe don't touch it in this PR then (it's unrelated to 12.3 anyway).
However, at the very least we should add something to state that it's deprecated; currently there's no indication that is the case.
There was a problem hiding this comment.
removing it from the nav bar (but not deleting the .md) just brings us in line with the main website. i think that's fine to leave in for this pr. we can add a warning that it's deprecated later
docs/book.md
Outdated
| <a class="anchor" id="sethighlight"></a>setHighlight(x1, y1, x2, y2) | Set highlight box on current page. | [<span class="ret boo"></span>](types.md) | ||
| <a class="anchor" id="clearhighlight"></a>clearHighlight() | Clear highlight. | [<span class="ret boo"></span>](types.md) |
There was a problem hiding this comment.
Should we add functions details for sethighlight and clearhighlight ?
There was a problem hiding this comment.
i don't know how they actually work. maybe benjamin can help
There was a problem hiding this comment.
Sorry, I haven't looked into these specifically and am about to head off. I reckon don't let this hold up the pull request. We can always add more details later.
There was a problem hiding this comment.
Let my do some research about this method.
There was a problem hiding this comment.
added some info about the setHighlight() function
|
did some testing and it seems like highlights only show when the PDF is popped out to screen, and don't work on game-load or after |
The Highlight is not saved. -- The bottom left corner will be highlighted (0,0 = bottom left corner and 0.5,0.5 = middle)
self.Book.setHighlight(0, 0, 0.5, 0.5) |
adds in new lua features from patch 12.3. Since this patch introduces a couple new types of spawnable objects, we also move spawnable objects to their own subcategory in the scripting api nav menu.
closes #14 . one thing i'm curious about is the pdf highlight function, i never got it to work. otherwise please leave any feedback etc.