Resource:Helpmanager - Revision history

FileEX: Added PL

2024-04-12T12:22:55Z

Added PL

← Older revision		Revision as of 12:22, 12 April 2024
Line 56:		Line 56:

	[[ru:Resource:Helpmanager]]		[[ru:Resource:Helpmanager]]
			[[pl:Resource:Helpmanager]]

Myonlake: Myonlake moved page Resource:Resource:helpmanager to Resource:Helpmanager over redirect

2021-02-21T22:22:20Z

Myonlake moved page Resource:Resource:helpmanager to Resource:Helpmanager over redirect

← Older revision

Revision as of 22:22, 21 February 2021

Myonlake: Myonlake moved page Resource:Helpmanager to Resource:Resource:helpmanager

2021-02-21T22:21:39Z

Myonlake moved page Resource:Helpmanager to Resource:Resource:helpmanager

← Older revision	Revision as of 22:21, 21 February 2021
(No difference)

Vincent at 19:38, 15 May 2012

2012-05-15T19:38:30Z

← Older revision		Revision as of 19:38, 15 May 2012
Line 54:		Line 54:
	<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>		<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>
	<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>		<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>

			[[ru:Resource:Helpmanager]]

Jbeta: Helpmanager moved to Resource:Helpmanager

2008-01-01T02:10:13Z

Helpmanager moved to Resource:Helpmanager

← Older revision	Revision as of 02:10, 1 January 2008
(No difference)

Jbeta at 02:08, 1 January 2008

2008-01-01T02:08:20Z

← Older revision		Revision as of 02:08, 1 January 2008
Line 1:		Line 1:
			{{Resource page}}
	The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.		The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.

JHXP: User:Jbeta/helpmanager moved to Helpmanager

2008-01-01T00:22:21Z

User:Jbeta/helpmanager moved to Helpmanager

← Older revision

Revision as of 00:22, 1 January 2008

Jbeta at 02:44, 16 November 2007

2007-11-16T02:44:38Z

← Older revision		Revision as of 02:44, 16 November 2007
Line 1:		Line 1:
	The help manager centralizes script help GUIs and provides a simple way to add instructions.		The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.

	==Usage==		==Usage==
Line 7:		Line 7:
	<config src="help.xml" type="client"/>		<config src="help.xml" type="client"/>
	</syntaxhighlight>		</syntaxhighlight>
	The contents below the root node of your '''help.xml''' file will be shown under the resource's help tab.		The contents below the root node of your '''help.xml''' file will be shown under the resource's help tab. Also, an optional popup="no" can be added to the root node to specify that you don't want the user to be notified with a popup when the page is available.

	For example:		For example:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<help>		<help popup="no">
	Help text here		Help text here
	</help>		</help>
Line 21:		Line 21:
	You can add your custom help GUI by adding the tab manually in a client script:		You can add your custom help GUI by adding the tab manually in a client script:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource())		myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)
	</syntaxhighlight>		</syntaxhighlight>
	You can add contents by using the returned GUI element as GUI parent for your widgets. It is not necessary to destroy them on page remove / resource stop, as the manager does cleanup.		You can add contents by using the returned GUI element as GUI parent for your widgets. It is not necessary to destroy them on page remove / resource stop, as the manager does cleanup.

Jbeta at 02:29, 16 November 2007

2007-11-16T02:29:28Z

← Older revision		Revision as of 02:29, 16 November 2007
Line 23:		Line 23:
	myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource())		myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource())
	</syntaxhighlight>		</syntaxhighlight>
	You can add contents by using the returned GUI element as GUI parent for your widgets.		You can add contents by using the returned GUI element as GUI parent for your widgets. It is not necessary to destroy them on page remove / resource stop, as the manager does cleanup.

	==Keys==		==Keys==
Line 43:		Line 43:
	<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>		<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>
	Hides the help window for the local player.		Hides the help window for the local player.
	<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource )</syntaxhighlight>		<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )</syntaxhighlight>
	Adds a gui-tab with the name of the resource passed to the local player's help GUI.		Adds a gui-tab with the name of the passed resource to the local player's help GUI. If showPopup is false, the "page available" popup is not shown.
			<syntaxhighlight lang="lua">bool removeHelpTab ( resource forResource )</syntaxhighlight>
			Adds a gui-tab with the name of the passed resource to the local player's help GUI.

	==Fired events==		==Fired events==

EAi: /* Simple GUI */

2007-11-13T23:40:17Z

Simple GUI

← Older revision		Revision as of 23:40, 13 November 2007
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>
	The contents below the root node of your '''help.xml''' file will be shown under the resource's help tab.		The contents below the root node of your '''help.xml''' file will be shown under the resource's help tab.

			For example:
			<syntaxhighlight lang="xml">
			<help>
			Help text here
			</help>
			</syntaxhighlight>

			Help text should explain how to play the gamemode, bound keys and console commands. The help is intended for the end user, not the developer so keep it simple.

	===Custom GUI===		===Custom GUI===