WildStar:API EVENT UI HealthChanged - Revision history

Bear at 07:41, 9 August 2023

2023-08-09T07:41:20Z

← Older revision		Revision as of 07:41, 9 August 2023
Line 2:		Line 2:
	The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.		The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.

	{{api\|\|Apollo\|RegisterEventHandler}}("UI_HealthChanged", "OnHealthChanged", self)		{{\\|api\|\|Apollo\|RegisterEventHandler}}("UI_HealthChanged", "OnHealthChanged", self)
	function MyAddOn:OnHealthChnaged(newValue, maxCharacterHealth)		function MyAddOn:OnHealthChnaged(newValue, maxCharacterHealth)

Bear at 07:37, 9 August 2023

2023-08-09T07:37:15Z

← Older revision		Revision as of 07:37, 9 August 2023
Line 1:		Line 1:
	{{~~../~~uiapievent\|name=UI_HealthChanged}}		{{\\|uiapievent\|name=UI_HealthChanged}}
	The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.		The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.

Bear: Bear moved page WildStar://API EVENT UI HealthChanged to WildStar:API EVENT UI HealthChanged without leaving a redirect

2023-08-09T03:22:37Z

Bear moved page //API EVENT UI HealthChanged to API EVENT UI HealthChanged without leaving a redirect

← Older revision

Revision as of 03:22, 9 August 2023

Bear: Bear moved page WildStar/API EVENT UI HealthChanged to WildStar://API EVENT UI HealthChanged

2023-08-09T03:09:07Z

Bear moved page WildStar/API EVENT UI HealthChanged to //API EVENT UI HealthChanged

← Older revision

Revision as of 03:09, 9 August 2023

Bear: Created page with "{{../uiapievent|name=UI_HealthChanged}} The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events...."

2020-07-07T04:34:43Z

Created page with "{{../uiapievent|name=UI_HealthChanged}} The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events...."

← Older revision		Revision as of 04:34, 7 July 2020
Line 1:		Line 1:
	{{uiapievent\|name=UI_HealthChanged}}		{{../uiapievent\|name=UI_HealthChanged}}
	The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.		The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.

Line 11:		Line 11:

	;Returns		;Returns
			: none

	== Summary ==		== Summary ==

Bear at 22:23, 27 June 2014

2014-06-27T22:23:49Z

← Older revision		Revision as of 22:23, 27 June 2014
Line 1:		Line 1:
			{{uiapievent\|name=UI_HealthChanged}}
	The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.		The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.

	Due to it's ability to trigger whenever the players health on the UI bar changes this event can be used for doing something when the player reaches a certain percentage of health or you could use it for determining whether or not your health is full. It's also possible to do react to when the health of the player reaches zero.		{{api\|\|Apollo\|RegisterEventHandler}}("UI_HealthChanged", "OnHealthChanged", self)
			function MyAddOn:OnHealthChnaged(newValue, maxCharacterHealth)

	== Usage ==		== Usage ==
			;Parameters
			:newValue [number] - current health. amount of health the player has, like 26774
			:maxPlayerHealth [number] - current maximum amount of maximal health the player can have

	~~The UI_HealthChanged is registered via ''RegisterEventHandler ''in the following manner:~~		;Returns
	~~Apollo.RegisterEventHandler("UI_HealthChanged", "''<yourFunctionName>''", self)~~
	~~After the event has been registered we create a new function in our Addon.~~
	~~function ''<yourAddonName>'':''<yourFunctionName>''(''<varCurrHealth>'', ''<varMaxPlayerHealth>'')~~
	~~'' ''Parameters: - The amount of health the player has (as number e.g. 26774)~~

	~~- The amount~~ of ~~maximal~~ health the player ~~has (as number)~~		== Summary ==
			Due to it's ability to trigger whenever the players health on the UI bar changes this event can be used for doing something when the player reaches a certain percentage of health or you could use it for determining whether or not your health is full. It's also possible to do react to when the health of the player reaches zero.

	== Example ==		== Example ==
	Apollo.RegisterEventHandler("UI_HealthChanged", "OnDeath", self)		Apollo.RegisterEventHandler("UI_HealthChanged", "OnDeath", self)


	function MyAddon:OnDeath(current, max)<br>		function MyAddon:OnDeath(current, max)<br>
Line 22:		Line 23:
	end<br>		end<br>
	end		end

	First we register the event by calling RegisterEventHandler. The first argument is the event "UI_HealthChanged" the second argument is the function we want to call when the event is triggered which is going to be "OnDeath" in this example. As the last argument we give RegisterEventHandler our Addon by using self.		First we register the event by calling RegisterEventHandler. The first argument is the event "UI_HealthChanged" the second argument is the function we want to call when the event is triggered which is going to be "OnDeath" in this example. As the last argument we give RegisterEventHandler our Addon by using self.

	Now since the event is registered, we're going to create a new function in our addon which receives the current health of the player and the max health of the player. By checking whether or not the current health equals zero or lower we can check whether or not the player died. Once we figured out we're going to send a message to the system channel that says "You're dead".		Now since the event is registered, we're going to create a new function in our addon which receives the current health of the player and the max health of the player. By checking whether or not the current health equals zero or lower we can check whether or not the player died. Once we figured out we're going to send a message to the system channel that says "You're dead".

84.142.99.254: Created the page.

2014-06-27T15:44:10Z

Created the page.

New page

The '''UI_HealthChanged''' global event triggers whenever the players health bar on the UI changes. It must register to receive events.

Due to it's ability to trigger whenever the players health on the UI bar changes this event can be used for doing something when the player reaches a certain percentage of health or you could use it for determining whether or not your health is full. It's also possible to do react to when the health of the player reaches zero.

== Usage ==

The UI_HealthChanged is registered via ''RegisterEventHandler ''in the following manner:
Apollo.RegisterEventHandler("UI_HealthChanged", "''<yourFunctionName>''", self)
After the event has been registered we create a new function in our Addon.
function ''<yourAddonName>'':''<yourFunctionName>''(''<varCurrHealth>'', ''<varMaxPlayerHealth>'')
'' ''Parameters: - The amount of health the player has (as number e.g. 26774)

- The amount of maximal health the player has (as number)

== Example ==
Apollo.RegisterEventHandler("UI_HealthChanged", "OnDeath", self)

function MyAddon:OnDeath(current, max)<br>
if current <= 0 then<br>
ChatSystemLib.PostOnChannel(CHANNEL.SYSTEM, "You're dead")<br>
end<br>
end
First we register the event by calling RegisterEventHandler. The first argument is the event "UI_HealthChanged" the second argument is the function we want to call when the event is triggered which is going to be "OnDeath" in this example. As the last argument we give RegisterEventHandler our Addon by using self.

Now since the event is registered, we're going to create a new function in our addon which receives the current health of the player and the max health of the player. By checking whether or not the current health equals zero or lower we can check whether or not the player died. Once we figured out we're going to send a message to the system channel that says "You're dead".