This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eGetPlayerMotto"
From BZFlagWiki
(→Uses: Accidently used BBCode instead of wiki syntax.) |
(→Data: Found out every single event outputs eventTime...So went ahead and put it here.) |
||
| Line 20: | Line 20: | ||
|bz_ApiString | |bz_ApiString | ||
|The motto of the joining player. | |The motto of the joining player. | ||
| + | |eventTime | ||
| + | |double | ||
| + | |The server time the event occurred (in seconds.) | ||
|} | |} | ||
==Uses== | ==Uses== | ||
This event is called '''before''' the ePlayerJoinEvent. So what you can do is store the motto in a string, and later check it when you get the other player data. As of 2.4.0, this is the only method of getting the motto. | This event is called '''before''' the ePlayerJoinEvent. So what you can do is store the motto in a string, and later check it when you get the other player data. As of 2.4.0, this is the only method of getting the motto. | ||
Revision as of 18:18, 15 October 2011
| BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.
Overview
The bz_eGetPlayerMotto is an API event that is called when the player joins. It gives us the motto of the player.
Data
bz_eGetPlayerMotto returns the bz_GetPlayerMottoData_V1 data class.
| name | type | value description | |||
|---|---|---|---|---|---|
| eventType | bz_eEventType | bz_eGetPlayerMotto | |||
| motto | bz_ApiString | The motto of the joining player. | eventTime | double | The server time the event occurred (in seconds.) |
Uses
This event is called before the ePlayerJoinEvent. So what you can do is store the motto in a string, and later check it when you get the other player data. As of 2.4.0, this is the only method of getting the motto.
