Action wheel (tutorial) - Revision history

TheKillerBunny at 17:28, 10 December 2024

2024-12-10T17:28:28Z

← Older revision		Revision as of 17:28, 10 December 2024
Line 1:		Line 1:
			{{Distinguish\|ActionWheelAPI}}
	The Action Wheel is a GUI element added by Figura which allows you to add additional functionality to your avatar.		The Action Wheel is a GUI element added by Figura which allows you to add additional functionality to your avatar.

PenguinEncounter: end road work

2024-12-01T05:42:13Z

end road work

← Older revision		Revision as of 05:42, 1 December 2024
Line 1:		Line 1:
	~~{{Notice/Warning\|This page is under construction.}}~~

	The Action Wheel is a GUI element added by Figura which allows you to add additional functionality to your avatar.		The Action Wheel is a GUI element added by Figura which allows you to add additional functionality to your avatar.

PenguinEncounter: /* Using multiple Pages */ add more lines

2024-12-01T05:37:15Z

Using multiple Pages: add more lines

← Older revision		Revision as of 05:37, 1 December 2024
Line 229:		Line 229:
	Do something similar to create a second action to go back:		Do something similar to create a second action to go back:

	<syntaxhighlight lang="lua" line ~~start="6"~~ highlight="10-15">		<syntaxhighlight lang="lua" line highlight="15-20">
			local mainPage = action_wheel:newPage()
			local secondPage = action_wheel:newPage()
			action_wheel:setPage(mainPage)

			-- This action switches to the second page when clicked.
	local switchToSecond = mainPage:newAction()		local switchToSecond = mainPage:newAction()
	:title("Switch To Second Page")		:title("Switch To Second Page")

PenguinEncounter: /* Using multiple Pages */ oups

2024-12-01T05:36:32Z

Using multiple Pages: oups

← Older revision		Revision as of 05:36, 1 December 2024
Line 204:		Line 204:

	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	local ~~firstPage~~ = action_wheel:newPage()		local mainPage = action_wheel:newPage()
	local secondPage = action_wheel:newPage()		local secondPage = action_wheel:newPage()
	action_wheel:setPage(mainPage)		action_wheel:setPage(mainPage)

PenguinEncounter: "using multiple pages"

2024-12-01T05:36:01Z

"using multiple pages"

← Older revision		Revision as of 05:36, 1 December 2024
Line 197:		Line 197:
	:setOnToggle(pings.toggleModel)		:setOnToggle(pings.toggleModel)
	</syntaxhighlight>		</syntaxhighlight>

			== Using multiple Pages ==
			Using multiple pages allows you to create more complex setups, such as an action opening a 'sub-menu' of sorts with more actions.

			Setting up multiple pages is pretty simple — use <code>newPage</code> multiple times and store each page in its own variable.

			<syntaxhighlight lang="lua" line>
			local firstPage = action_wheel:newPage()
			local secondPage = action_wheel:newPage()
			action_wheel:setPage(mainPage)
			</syntaxhighlight>

			Create an action to switch to a different page:

			<syntaxhighlight lang="lua" line highlight="5-13">
			local mainPage = action_wheel:newPage()
			local secondPage = action_wheel:newPage()
			action_wheel:setPage(mainPage)

			-- This action switches to the second page when clicked.
			local switchToSecond = mainPage:newAction()
			:title("Switch To Second Page")
			:item("arrow")
			:onLeftClick(function()
			-- You don't need to ping page changes because they only matter
			-- on the host (viewers don't care)
			action_wheel:setPage(secondPage)
			end)
			</syntaxhighlight>

			Do something similar to create a second action to go back:

			<syntaxhighlight lang="lua" line start="6" highlight="10-15">
			local switchToSecond = mainPage:newAction()
			:title("Switch To Second Page")
			:item("arrow")
			:onLeftClick(function()
			-- You don't need to ping page changes because they only matter
			-- on the host (viewers don't care)
			action_wheel:setPage(secondPage)
			end)

			local switchToMain = secondPage:newAction()
			:title("Switch To Main Page")
			:item("item_frame")
			:onLeftClick(function()
			action_wheel:setPage(mainPage)
			end)
			</syntaxhighlight>

			Now you should be able to switch between the pages! Each page has its own set of actions.

PenguinEncounter at 05:25, 1 December 2024

2024-12-01T05:25:02Z

← Older revision		Revision as of 05:25, 1 December 2024
Line 176:		Line 176:
	Toggle functions accept one argument (the toggle state, a {{type\|boolean}}).		Toggle functions accept one argument (the toggle state, a {{type\|boolean}}).

	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line highlight="19">
	-- this uses the mainPage from the previous tutorial		-- this uses the mainPage from the previous tutorial

PenguinEncounter: add toggle example

2024-12-01T05:24:09Z

add toggle example

@@ Line 165: / Line 165: @@
      :hoverColor(1, 0, 1)
      :onLeftClick(pings.actionClicked)
 </syntaxhighlight>

PenguinEncounter: /* Making Actions work in multiplayer */ uhm actually

2024-12-01T03:53:55Z

Making Actions work in multiplayer: uhm actually

← Older revision		Revision as of 03:53, 1 December 2024
Line 89:		Line 89:

	{{Notice/Warning\|content=		{{Notice/Warning\|content=
	All ~~actions~~ '''must have unique names'''. If you're adding multiple actions, you need to '''use a different name for each ~~action~~ function.''' Otherwise, every Action will run the same function (this is probably not what you want!)		All ping functions '''must have unique names'''. If you're adding multiple actions, you need to '''use a different name for each ping function.''' Otherwise, every Action will run the same function (this is probably not what you want!)
	}}		}}

PenguinEncounter: finished the basic example

2024-12-01T03:53:20Z

finished the basic example

Show changes

PenguinEncounter: fix warn

2024-12-01T03:04:33Z

fix warn

← Older revision		Revision as of 03:04, 1 December 2024
Line 1:		Line 1:
	{{Notice/Warning\|This page is under construction.}}		{{Notice/Warning\|This page is under construction.}}

	{{Notice/Warning		{{Notice/Warning\|content=
	\|<span style="font-size: 1.4rem;">Untested scripts</span><br>Handle with care.		<span style="font-size: 1.4rem; font-weight: bolder;">Untested scripts</span><br>
			Handle with care.
	}}		}}