Squirrel/Server/Functions/Blips/DisplayType
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example 1. Returning the value) |
(→Notes) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Squirrel/Title|Blip.DisplayType}} | {{Squirrel/Title|Blip.DisplayType}} | ||
| − | This ''Blip'' class member returns or sets the display type of the radar blip. | + | This ''Blip'' class member returns or sets the display type of the radar blip. Note that some of the possible values only affect blips tied to entities, which currently can't be modified via scripts. |
== Syntax == | == Syntax == | ||
| + | |||
You can either return or set a new value using this member: | You can either return or set a new value using this member: | ||
<code>int Blip.DisplayType</code> | <code>int Blip.DisplayType</code> | ||
| Line 12: | Line 13: | ||
== Example 1. Returning the value == | == Example 1. Returning the value == | ||
| + | |||
| + | This example command returns the display type of blip ID 0 when someone types ''/type''. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( pPlayer, szCommand, szText ) | function onPlayerCommand( pPlayer, szCommand, szText ) | ||
{ | { | ||
| − | + | if ( szCommand == "type" ) | |
| − | + | { | |
| − | + | local pBlip = FindBlip( 0 ); | |
| − | + | if ( pBlip ) MessagePlayer( "Blip ID 0 is type ID - " + pBlip.DisplayType, pPlayer ); | |
| − | + | } | |
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 26: | Line 31: | ||
=== Notes === | === Notes === | ||
| − | The | + | The functions [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]], [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]] 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 == | ||
| − | + | This example function will set the display type of blip ID 0 to BLIPTYPE_NONE when someone types '/bliptype'. | |
| + | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
| + | { | ||
| + | if ( szCommand == "bliptype" ) | ||
| + | { | ||
| + | local pBlip = FindBlip( 0 ); | ||
| + | if ( pBlip ) pBlip.DisplayType = BLIPTYPE_NONE; | ||
| + | } | ||
| + | |||
| + | return 1; | ||
| + | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
| − | + | The function [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]] 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 15:36, 29 September 2010
This Blip class member returns or sets the display type of the radar blip. Note that some of the possible values only affect blips tied to entities, which currently can't be modified via scripts.
[edit] Syntax
You can either return or set a new value using this member:
[edit] Arguments
- newtype - The new type of the blip. For reference, check here.
[edit] Example 1. Returning the value
This example command returns the display type of blip ID 0 when someone types /type.
[edit] Notes
The functions MessagePlayer, FindBlip 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 function will set the display type of blip ID 0 to BLIPTYPE_NONE when someone types '/bliptype'.
[edit] Notes
The function FindBlip and event onPlayerCommand were used in this example. More info about them in the corresponding pages.
