TPlayers.GetByName - Revision history

Mighty: fixing example, checking if Nil wasn't needed before

2013-07-25T06:40:51Z

fixing example, checking if Nil wasn't needed before

Mighty: new page

2013-07-25T06:38:44Z

new page

New page

'''''function GetByName(Name: string): [[TActivePlayer]]'''''
Name: name to be searched for

==Description==
Returns a [[TActivePlayer]] whose name is equal to the searched one. '''Case sensitive.'''<br>
Returns '''Nil''' if a player was not found.<br>
'''Warning''': Trying to work on a "Nil-player" (result of the function when a player was not found) might throw exceptions or be critical. Remember to make sure a player was found before you try to do anything with him.

== Example ==
Example is trying to find a nickname "~ Mighty" among players and displays proper information to all players.
<syntaxhighlight lang="pascal">
var
p: TActivePlayer;
begin
p := Players.GetByName('~ Mighty');
if p = Nil then // important
Players.Tell('Mighty is not playing here atm ;(')
else
Players.Tell('Hello Mighty!');
end;
</syntaxhighlight>

[[Category:TActivePlayer]]

@@ Line 8: / Line 8: @@
 == Example ==
-Example is trying to find a nickname "~ Mighty" among players and displays proper information to all players.
+Example is trying to find a nickname "~ Mighty" among players and displays proper information to all players (or to player if found).
 <syntaxhighlight lang="pascal">
 var
@@ Line 17: / Line 17: @@
      Players.Tell('Mighty is not playing here atm ;(')
    else
-     Players.Tell('Hello Mighty!');
+     p.Tell('Hello Mighty!');
 end;
 </syntaxhighlight>
 [[Category:TActivePlayer]]