Entity::setAlpha: Difference between revisions

From RAGE Multiplayer Wiki
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
skin - everything alpha except skin<br>Set entity alpha level. Ranging from 0 to 255 but chnages occur after every 20 percent (after every 51).
skin - everything alpha except skin<br>Set entity alpha level. Ranging from 0 to 255 but chnages occur after every 20 percent (after every 51).
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">entity.setAlpha(alphaLevel, skin);</syntaxhighlight>
<pre>entity.setAlpha(alphaLevel);</pre>
 
=== Required Arguments ===
=== Required Arguments ===
*'''alphaLevel:''' int
=== Old Arguments ===
*'''alphaLevel:''' int
*'''alphaLevel:''' int
*'''skin:''' Boolean
*'''skin:''' Boolean
** The "skin" parameter is not used with vehicles and will cause errors if used.
 
** The "skin" parameter is used only for peds, otherwise it will cause argument count exceptions if used.
 
===Return value===
===Return value===
*'''Undefined'''
*'''Undefined'''


==Example==
==Example==
<syntaxhighlight lang="javascript">
{{ClientsideCode|
// todo
<pre>
</syntaxhighlight>
mp.events.add('enableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, true);
player.vehicle.setAlpha(255);
player.setAlpha(255);
});
});
 
mp.events.add('disableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, false);
player.vehicle.setAlpha(102);
player.setAlpha(255);
});
});
</pre>
}}
 
==See also==
==See also==
{{Entity_function_c}}
{{Entity_definition_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]

Latest revision as of 17:57, 1 May 2024

skin - everything alpha except skin
Set entity alpha level. Ranging from 0 to 255 but chnages occur after every 20 percent (after every 51).

Syntax

entity.setAlpha(alphaLevel);

Required Arguments

  • alphaLevel: int

Old Arguments

  • alphaLevel: int
  • skin: Boolean
    • The "skin" parameter is used only for peds, otherwise it will cause argument count exceptions if used.

Return value

  • Undefined

Example

Client-Side
mp.events.add('enableCollisions', () => {
	mp.players.forEach(player => {
		mp.players.local.vehicle.setNoCollision(player.vehicle.handle, true);
		player.vehicle.setAlpha(255);
		player.setAlpha(255);
	});
});

mp.events.add('disableCollisions', () => {
	mp.players.forEach(player => {
		mp.players.local.vehicle.setNoCollision(player.vehicle.handle, false);
		player.vehicle.setAlpha(102);
		player.setAlpha(255);
	});
});

See also