Squirrel/Server/Functions/Vehicles/RGBColour2

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|Vehicle.Colour2}} This ''Vehicle'' class member returns or sets a custom secondary colour for the vehicle. Note that if [[Squirrel/Server/Functions/Vehicles/Colo…')
 
 
Line 1: Line 1:
−
{{Squirrel/Title|Vehicle.Colour2}}
+
{{Squirrel/Title|Vehicle.RGBColour2}}
 
This ''Vehicle'' class member returns or sets a custom secondary colour for the vehicle. Note that if [[Squirrel/Server/Functions/Vehicles/Colour2|Vehicle.Colour2]] is used to change the colour, it will override this setting.
 
This ''Vehicle'' class member returns or sets a custom secondary colour for the vehicle. Note that if [[Squirrel/Server/Functions/Vehicles/Colour2|Vehicle.Colour2]] is used to change the colour, it will override this setting.
  
Line 14: Line 14:
 
== Example 1. Returning the value ==
 
== Example 1. Returning the value ==
  
−
-- Example description here
 
−
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
−
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
if ( szCommand == "rgb" )
 +
{
 +
if ( pPlayer.Vehicle ) MessagePlayer( "Vehicle RGB colour is " + pPlayer.Vehicle.RGBColour2, pPlayer );
 +
}
 +
 +
return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
−
-- Example notes and used functions here.
+
The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
  
 
== Example 2. Setting a new value ==
 
== Example 2. Setting a new value ==
  
−
-- Example description here
 
−
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
−
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
if ( szCommand == "rgb2" )
 +
{
 +
if ( pPlayer.Vehicle ) pPlayer.Vehicle.RGBColour2 = Colour( 0, 255, 0 );
 +
}
 +
 
 +
return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
−
-- Example notes and used functions here.
+
The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in this example. More info about this in the corresponding page.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Vehicles}}
 
{{Squirrel/Server/Functions/Vehicles}}

Latest revision as of 17:33, 29 September 2010

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Vehicle class member returns or sets a custom secondary colour for the vehicle. Note that if Vehicle.Colour2 is used to change the colour, it will override this setting.

[edit] Syntax

You can either return or set a new value using this member: 

  1. Colour Vehicle.RGBColour2
  1. Vehicle.RGBColour2 = Colour col

[edit] Arguments

  • col - This is a pointer to the custom RGB colour object to be used as the vehicle's secondary colour

[edit] Example 1. Returning the value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "rgb" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) MessagePlayer( "Vehicle RGB colour is " + pPlayer.Vehicle.RGBColour2, pPlayer );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

[edit] Example 2. Setting a new value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "rgb2" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) pPlayer.Vehicle.RGBColour2 = Colour( 0, 255, 0 );
  7. 	}
  8.  
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The event onPlayerCommand was used in this example. More info about this in the corresponding page.

[edit] Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Vehicles/RGBColour2&oldid=1779"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox