Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:23Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=WorldObject}}
Moves a window once to the screen position of a world object.

<pre>
MoveWindowToWorldObject(windowName, worldObjectId, heightScale)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window to move.
;worldObjectId : <code>number</code> – ID of the world object.
;heightScale : <code>number</code> – Factor applied to the object's height value. <code>0</code> uses the object's base position; <code>1.0</code> raises the point by the full height value (the stock chat bubbles use <code>1.0</code>).

== Returns ==
Nothing.

== Details ==
* Unlike [[API:AttachWindowToWorldObject|AttachWindowToWorldObject]], this places the window only once. Call it again (the stock chat manager does so on every update) to keep the window on the object.
* If the object does not exist, nothing happens.
* For player objects the point is taken from the character's model when one is available, with its height multiplied by <code>heightScale</code>.
* The window is shown when the point is on screen and hidden when it is not.
* When the point is on screen, the window is moved so that it is centred horizontally on the point with its bottom edge on the point, then kept inside the screen.
* The function needs at least three arguments and only reads the last three.

== Errors ==
* <code>Error in function call 'MoveWindowToWorldObject': window %s does not exist</code>

== Example ==
Keeping a chat bubble above its speaker, from <code>default/ea_chatsystem/source/chatmanager.lua</code>:
<pre>
MoveWindowToWorldObject( "ChatBubbleWindow"..group, ChatManager.chatBubbleGroups[group].worldObject, 1.0 )
</pre>

== See also ==
* [[API:AttachWindowToWorldObject|AttachWindowToWorldObject]]
* [[API:WorldToScreen|WorldToScreen]]

API:MoveWindowToWorldObject - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)