Squirrel/Server/Functions/Blips/Pos

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Undo revision 1648 by Juppi (Talk) - Fixing a copypaste fuckup)
 
(3 intermediate revisions by one user not shown)
Line 13: Line 13:
 
== Example 1. Returning the value ==
 
== Example 1. Returning the value ==
  
{{Squirrel/NeedsExample}}
+
This example command prints the position of blip ID 0 on screen when someone types '/blippos'.
 +
 
 
<code lang="squirrel">
 
<code lang="squirrel">
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
    if ( szCommand == "blippos" )
 +
    {
 +
          local pBlip = FindBlip( 0 );
 +
          local vPos = pBlip.Pos;
 +
         
 +
          if ( pBlip ) MessagePlayer( "Blip ID 0 is at pos - " + vPos.x + ", " + vPos.y, pPlayer );
 +
    }
 +
   
 +
    return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
Example notes and used functions here.
+
The functions [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]], [[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 ==
  
{{Squirrel/NeedsExample}}
+
This example command will move blip ID 0 to player's position when they type '/setblippos'.
 +
 
 
<code lang="squirrel">
 
<code lang="squirrel">
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
    if ( szCommand == "setblippos" )
 +
    {
 +
          local pBlip = FindBlip( 0 );
 +
          if ( pBlip ) pBlip.Pos = pPlayer.Pos;
 +
    }
 +
   
 +
    return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
Example notes and used functions here.
+
The functions [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]], [[Squirrel/Server/Functions/Players/Pos|Player.Pos]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Blips}}
 
{{Squirrel/Server/Functions/Blips}}

Latest revision as of 00:18, 29 September 2010

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

This Blip class member returns or sets the position of the blip on the radar.

[edit] Syntax

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

  1. Vector Blip.Pos
  1. Blip.Pos = Vector newPos

[edit] Arguments

  • newPos - A vector representing the new position of the blip.

[edit] Example 1. Returning the value

This example command prints the position of blip ID 0 on screen when someone types '/blippos'.

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "blippos" )
  5. {
  6. local pBlip = FindBlip( 0 );
  7. local vPos = pBlip.Pos;
  8. if ( pBlip ) MessagePlayer( "Blip ID 0 is at pos - " + vPos.x + ", " + vPos.y, pPlayer );
  9. }
  10. return 1;
  11. }
  12.  

[edit] Notes

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

[edit] Example 2. Setting a new value

This example command will move blip ID 0 to player's position when they type '/setblippos'.

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "setblippos" )
  5. {
  6. local pBlip = FindBlip( 0 );
  7. if ( pBlip ) pBlip.Pos = pPlayer.Pos;
  8. }
  9. return 1;
  10. }
  11.  

[edit] Notes

The functions FindBlip, Player.Pos and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

[edit] Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox