Qrow: 1 revision imported

2025-11-13T02:24:12Z

1 revision imported

← Older revision	Revision as of 19:24, 12 November 2025
(No difference)

interwiki>Flozi: Flozi moved page MouseCursors to Gamedev:MouseCursors

2013-10-26T22:33:41Z

Flozi moved page MouseCursors to Gamedev:MouseCursors

New page

[[Engine_Development|Development]] < [[Mod_and_Unit_development|Game Development]] < {{FULLPAGENAME}}

=Mouse Cursors=
==Location==
Cursors for Spring are stored in the <code>Anims/</code> directory.

==Supported Image Formats==
The cursors have to be in either:
* png
* tga
* bmp
To make transparent sections in bmp's use RGB(84, 84, 252).<br/>
The images don't have to be squared neither power-of-two, but those are preferred and the size should be <=128.

==Filename==
Even if your cursor isn't animated, it must have the _0 at the end of its name.
Only when using a .txt this isn't needed.

==Animated Cursors==
===Via Filenames===
To make animated cursors, just make a sequence where the filenames start with '_0' at the end of the first in the sequence, going on sequentially until the last frame. This uses the default `frame time` (= the time each sprite is visible) of 0.1sec.

===Via .txt===
You can also create a .txt file with further specifications for your cursor:

<code>cursorattack.txt:</code>
<div>
<code><pre>
hotspot %hotspot
frame %filename_0 %timespan_0
frame %filename_1 %timespan_1
frame %filename_2 %timespan_2
...
</pre></code>
</div>
The <code>hotspot</code> tag is optional and can be either <code>topleft</code> or <code>center</code>.<br/>
Note, the filenames have to contain the full path, e.g. <code>Anims/CursorMove.png</code>.

=Engine Cursors=
Spring itself just needs one cursor and that's <code>cursornormal</code>, <span class=warning>if this isn't present in your game Spring will crash with an ContentError</span>.

Still there are additional cursors the engine will use when present:<br/>
<span class=note>(When cursors are double named in the table, it means that the following ones are fallbacks.)</span>
<div align="center">
<table width="60%" border="1" cellspacing=0>
<tr>
<th style="background: #CCC; color:#444">Cursor Name</th>
<th style="background: #CCC; color:#444">Internal Name/Usage</th>
<th style="background: #CCC; color:#444">Def. Hot Spot</th>
</tr>

<tr>
<td>cursornormal</td>
<td></td>
<td>TopLeft</td>
</tr>

<tr>
<td>cursorareaattack</td>
<td>Area attack</td>
<td>Center</td>
</tr>

<tr>
<td>cursorattack</td>
<td>Area attack</td>
<td>Center</td>
</tr>

<tr>
<td>cursorattack</td>
<td>Attack</td>
<td>Center</td>
</tr>

<tr>
<td>cursorattackbad</td>
<td>AttackBad</td>
<td>Center</td>
</tr>

<tr>
<td>cursorattack</td>
<td>AttackBad</td>
<td>Center</td>
</tr>

<tr>
<td>cursorbuildbad</td>
<td>BuildBad</td>
<td>Center</td>
</tr>

<tr>
<td>cursorbuildgood</td>
<td>BuildGood</td>
<td>Center</td>
</tr>

<tr>
<td>cursorcapture</td>
<td>Capture</td>
<td>Center</td>
</tr>

<tr>
<td>cursorcentroid</td>
<td>Centroid</td>
<td>Center</td>
</tr>

<tr>
<td>cursordwatch</td>
<td>DeathWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursorwait</td>
<td>DeathWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursordgun</td>
<td>DGun</td>
<td>Center</td>
</tr>

<tr>
<td>cursorattack</td>
<td>DGun</td>
<td>Center</td>
</tr>

<tr>
<td>cursorfight</td>
<td>Fight</td>
<td>Center</td>
</tr>

<tr>
<td>cursorattack</td>
<td>Fight</td>
<td>Center</td>
</tr>

<tr>
<td>cursorgather</td>
<td>GatherWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursorwait</td>
<td>GatherWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursordefend</td>
<td>Guard</td>
<td>Center</td>
</tr>

<tr>
<td>cursorpickup</td>
<td>Load units</td>
<td>Center</td>
</tr>

<tr>
<td>cursormove</td>
<td>Move</td>
<td>Center</td>
</tr>

<tr>
<td>cursorpatrol</td>
<td>Patrol</td>
<td>Center</td>
</tr>

<tr>
<td>cursorreclamate</td>
<td>Reclaim</td>
<td>Center</td>
</tr>

<tr>
<td>cursorrepair</td>
<td>Repair</td>
<td>Center</td>
</tr>

<tr>
<td>cursorrevive</td>
<td>Resurrect</td>
<td>Center</td>
</tr>

<tr>
<td>cursorrepair</td>
<td>Resurrect</td>
<td>Center</td>
</tr>

<tr>
<td>cursorrestore</td>
<td>Restore</td>
<td>Center</td>
</tr>

<tr>
<td>cursorrepair</td>
<td>Restore</td>
<td>Center</td>
</tr>

<tr>
<td>cursorselfd</td>
<td>SelfD</td>
<td>Center</td>
</tr>

<tr>
<td>cursornumber</td>
<td>SquadWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursorwait</td>
<td>SquadWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursortime</td>
<td>TimeWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursorwait</td>
<td>TimeWait</td>
<td>Center</td>
</tr>

<tr>
<td>cursorunload</td>
<td>Unload units</td>
<td>Center</td>
</tr>

<tr>
<td>cursorwait</td>
<td>Wait</td>
<td>Center</td>
</tr>
</table>
</div>

Example: A <code>cursorattack_0.bmp</code> (same for <code>cursorattack.txt</code>) in your <code>Anims/</code> dir will automatically used for attack commands.

=Lua/Custom Cursors=
==Runtime Replacing Default Cursors==
To runtime change cursors (e.g. per-faction cursors or user-configurable ones) you may want to use [[Lua_UnsyncedCtrl#GUI_2 | Spring.ReplaceMouseCursor]]. Example:

<code><pre>
Spring.ReplaceMouseCursor("cursorattack", "faction2_subdir/cursorattack")
Spring.ReplaceMouseCursor("cursormove", "faction2_subdir/cursormove")
...
</pre></code>

==Give Custom Commands a Cursor==
First you need to register your custom cursor with <code>Spring.AssignMouseCursor</code>. After that you can use it in <code>Spring.EditUnitCmdDesc/Spring.InsertUnitCmdDesc</code>:
<code><pre>
--loads cursor from foo_cursor.txt, foo_cursor_0.bmp, ...
Spring.AssignMouseCursor("mahcursor", "foo_cursor", false)

--NOTE: this is SYNCED code!
--add custom cmddesc
Spring.InsertUnitCmdDesc(unitID, {
...
cursor = "mahcursor",
...
})
</pre></code>

[[Category:Game Dev]]

Gamedev:MouseCursors - Revision history

Qrow: 1 revision imported

interwiki>Flozi: Flozi moved page MouseCursors to Gamedev:MouseCursors