arcantarget_hint(3)

πŸ“¦
version 0.7.1 Β· 2 versions
, in nixos 26.05

πŸ’– arcantarget_hint(3) πŸ’–

okay so this is the Arcan Lua API page for arcantarget_hint, and the whole vibe is: send a hint state through a frameserver tied to an arcan instance. no cap. 🫢


✨ NAME ✨

arcantarget_hint β€” send a hint state through a frameserver tied to an arcan instance. periodt. πŸ’…

πŸ’… SYNOPSIS πŸ’…

bool:ok
arcantarget_hint( string:kind, tbl:hint )
arcantarget_hint( vid:fsrv, string:kind, tbl:hint )

the way this works is you either pass kind + hint, or you put fsrv first and then kind + hint. iconic. ✨

πŸ¦‹ DESCRIPTION πŸ¦‹

When the arcan-in-arcan platform is used (the arcan_lwa binary), it can forward hints like any normal arcan-shmif client. These are from a subset of the ones that can be found in launch_target. πŸ¦‹

If fsrv is not provided, the default output, WORLDID, will be used. Otherwise it is expected that fsrv references a valid frameserver tied to a valid source from define_arcantarget or retrieved through the _adopt event handler. πŸ”₯

The currently supported ones are:

  • input_label β€” the format of the hint table matches that of the description in launch_target.
  • ident β€” with a string:message field in hint, provided as the new segment runtime identity (e.g. document name).
  • alert β€” with a string:message field in hint, provided as the reason for user attention.
  • statesize β€” with a int:size field in hint, provided as the estimated current output size of a state-save.
  • cursor β€” with a string:style matching the set in launch_target.

highkey that's the currently supported list, bestie. πŸ’–

πŸŽ€ EXAMPLE πŸŽ€

function arcantarget_hint0()
      arcantarget_hint("input_label",
      {
            labelhint = "test",
            description = "this should register as a digital button",
      })
end

🌈 EXAMPLE 🌈

function arcantarget_hint1()
      arcantarget_hint("cursor", {style = "move"})
end

πŸ”₯ SEE ALSO: πŸ”₯

  • targetcontrol

cute sign-off: targetcontrol β€’ October 2026 β€’ arcantarget_hint(3) β€” mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from