|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==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''' or '''bz_GetPlayerMottoData_V2''' data class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eGetPlayerMotto
| |
| |-
| |
| |motto
| |
| |bz_ApiString
| |
| |The motto of the joining player.
| |
| |-
| |
| |record
| |
| |[[bz_BasePlayerRecord]]
| |
| |The player record for the player using the motto (requires bz_GetPlayerMottoData_V2).
| |
| |-
| |
| |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.
| |