https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AHorizontalScrollWindowSetOffsetAPI:HorizontalScrollWindowSetOffset - Revision history2026-10-17T11:08:56ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:HorizontalScrollWindowSetOffset&diff=30500&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:45:33Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=ScrollWindow}}<br />
Scrolls a HorizontalScrollWindow to a horizontal offset.<br />
<br />
<pre><br />
HorizontalScrollWindowSetOffset(scrollWindowName, offset)<br />
</pre><br />
<br />
== Arguments ==<br />
;scrollWindowName : <code>string</code> – Name of the HorizontalScrollWindow.<br />
;offset : <code>number</code> – Distance in pixels from the left edge of the content to the left edge of the visible area.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* This is the horizontal counterpart of [[API:ScrollWindowSetOffset|ScrollWindowSetOffset]] and behaves the same way, using widths instead of heights.<br />
* The offset is clamped to the range from 0 to the content width minus the window width (0 if the content is not wider than the window). The content width is the one last measured by [[API:HorizontalScrollWindowUpdateScrollRect|HorizontalScrollWindowUpdateScrollRect]].<br />
* If the clamped offset is the same as the current one, nothing happens. Otherwise the scroll child and the scroll bar, if any, are moved.<br />
* The stock UI never calls this function.<br />
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.<br />
<br />
== Errors ==<br />
The error messages always use the name <code>HorizontalScrollWindowSetOffset</code>:<br />
* <code>Error in function call 'HorizontalScrollWindowSetOffset': Window %s does not exist</code><br />
* <code>Error in function call 'HorizontalScrollWindowSetOffset': Window %s is not a HorizontalScrollWindow</code><br />
<br />
== Example ==<br />
A minimal example built from the signature:<br />
<pre><br />
HorizontalScrollWindowUpdateScrollRect( "MyHScrollWindow" )<br />
HorizontalScrollWindowSetOffset( "MyHScrollWindow", 0 )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:HorizontalScrollWindowGetOffset|HorizontalScrollWindowGetOffset]]<br />
* [[API:HorizontalScrollWindowUpdateScrollRect|HorizontalScrollWindowUpdateScrollRect]]<br />
* [[API:ScrollWindowSetOffset|ScrollWindowSetOffset]]</div>Maintenance script