Maniaplanet¶
Flow¶
- pyplanet.apps.core.maniaplanet.callbacks.flow.loading_map_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Loading Map end.
- Code:
maniaplanet:loading_map_end
- Description:
Callback sent when the server finishes to load the map.
- Original Callback:
Script Maniaplanet.LoadingMap_End
- Parameters:
map (pyplanet.core.maniaplanet.models.map.Map) – Map instance from database. Updated with the provided data.
- pyplanet.apps.core.maniaplanet.callbacks.flow.loading_map_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Loading Map start.
- Code:
maniaplanet:loading_map_start
- Description:
Callback sent when the server starts loading the map.
- Original Callback:
Script Maniaplanet.LoadingMap_Start
- Parameters:
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.match_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Match End.
- Code:
maniaplanet:match_end
- Description:
Callback sent when the “EndMatch” section start.
- Original Callback:
Script Maniaplanet.EndMatch_Start
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.match_end__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Match End. (End event)
- Code:
maniaplanet:match_end__end
- Description:
Callback sent when the “EndMatch” section ends.
- Original Callback:
Script Maniaplanet.EndMatch_End
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.match_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Match Start.
- Code:
maniaplanet:match_start
- Description:
Callback sent when the “StartMatch” section start.
- Original Callback:
Script Maniaplanet.StartMatch_Start
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.match_start__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Match Start. (End event)
- Code:
maniaplanet:match_start__end
- Description:
Callback sent when the “StartMatch” section end.
- Original Callback:
Script Maniaplanet.StartMatch_End
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.play_loop_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Play Loop End.
- Code:
maniaplanet:play_loop_end
- Description:
Callback sent when the “PlayLoop” section ends.
- Original Callback:
Script Maniaplanet.EndPlayLoop
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.play_loop_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Play Loop Start.
- Code:
maniaplanet:play_loop_start
- Description:
Callback sent when the “PlayLoop” section starts.
- Original Callback:
Script Maniaplanet.StartPlayLoop
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.podium_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Podium end.
- Code:
maniaplanet:podium_end
- Description:
Callback sent when the podium sequence ends.
- Original Callback:
Script Maniaplanet.Podium_End
- Parameters:
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.podium_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Podium start.
- Code:
maniaplanet:podium_start
- Description:
Callback sent when the podium sequence starts.
- Original Callback:
Script Maniaplanet.Podium_Start
- Parameters:
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.round_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Round Start.
- Code:
maniaplanet:round_end
- Description:
Callback sent when the “EndRound” section starts.
- Original Callback:
Script Maniaplanet.EndRound_Start
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.round_end__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Round Start. (End event)
- Code:
maniaplanet:round_end__end
- Description:
Callback sent when the “EndRound” section ends.
- Original Callback:
Script Maniaplanet.EndRound_End
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.round_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Round Start.
- Code:
maniaplanet:round_start
- Description:
Callback sent when the “StartRound” section starts.
- Original Callback:
Script Maniaplanet.StartRound_Start
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
valid – Number of valid rounds, only on newer TM2020 dedicated servers.
- pyplanet.apps.core.maniaplanet.callbacks.flow.round_start__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Round Start. (End event)
- Code:
maniaplanet:round_start__end
- Description:
Callback sent when the “StartRound” section ends.
- Original Callback:
Script Maniaplanet.StartRound_End
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.server_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Server End signal
- Code:
maniaplanet:server_end
- Description:
This callback is called when the server script is end. The begin of the event.
- Original Callback:
Script Maniaplanet.EndServer_Start
- Parameters:
restarted – Boolean giving information if the script has restarted.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.server_end__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Server End signal (end event)
- Code:
maniaplanet:server_end__end
- Description:
This callback is called when the server script is end. The end of the event.
- Original Callback:
Script Maniaplanet.EndServer_End
- Parameters:
restarted – Boolean giving information if the script has restarted.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.server_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Server Start signal
- Code:
maniaplanet:server_start
- Description:
This callback is called when the server script is (re)started. The begin of the event.
- Original Callback:
Script Maniaplanet.StartServer_Start
- Parameters:
restarted – Boolean giving information if the script has restarted.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.server_start__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Server Start signal (end of event).
- Code:
maniaplanet:server_start__end
- Description:
This callback is called when the server script is (re)started. The end of the event.
- Original Callback:
Script Maniaplanet.StartServer_End
- Parameters:
restarted – Boolean giving information if the script has restarted.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.status_changed = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Server Status Changed.
- Code:
maniaplanet:status_changed
- Description:
Callback sent when the podium sequence ends.
- Original Callback:
Native Maniaplanet.Podium_End
- Parameters:
1 (int) – Status Code.
2 (str) – Status Name.
- pyplanet.apps.core.maniaplanet.callbacks.flow.turn_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Turn End.
- Code:
maniaplanet:turn_end
- Description:
Callback sent when the “EndTurn” section starts.
- Original Callback:
Script Maniaplanet.EndTurn_Start
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.turn_end__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Turn End. (End event)
- Code:
maniaplanet:turn_end__end
- Description:
Callback sent when the “EndTurn” section ends.
- Original Callback:
Script Maniaplanet.EndTurn_End
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.turn_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Turn Start.
- Code:
maniaplanet:turn_start
- Description:
Callback sent when the “StartTurn” section starts.
- Original Callback:
Script Maniaplanet.StartTurn_Start
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.turn_start__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Turn Start. (End event).
- Code:
maniaplanet:turn_start__end
- Description:
Callback sent when the “StartTurn” section ends.
- Original Callback:
Script Maniaplanet.StartTurn_End
- Parameters:
count – Each time this section is played, this number is incremented by one.
time – Server time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.flow.unloading_map_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Unloading of the Map ends.
- Code:
maniaplanet:unloading_map_end
- Description:
Callback sent when the server finishes to unload a map.
- Original Callback:
Script Maniaplanet.UnloadingMap_End
- Parameters:
map (pyplanet.core.maniaplanet.models.map.Map) – Map instance from database. Updated with the provided data.
- pyplanet.apps.core.maniaplanet.callbacks.flow.unloading_map_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Unloading of the Map starts.
- Code:
maniaplanet:unloading_map_start
- Description:
Callback sent when the server starts to unload a map.
- Original Callback:
Script Maniaplanet.UnloadingMap_Start
- Parameters:
map (pyplanet.core.maniaplanet.models.map.Map) – Map instance from database. Updated with the provided data.
Map¶
- pyplanet.apps.core.maniaplanet.callbacks.map.map_begin = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Begin of map.
- Code:
maniaplanet:map_begin
- Description:
Callback sent when map begins.
- Original Callback:
Native Maniaplanet.BeginMap
- Parameters:
map (pyplanet.apps.core.maniaplanet.models.map.Map) – Map instance.
- pyplanet.apps.core.maniaplanet.callbacks.map.map_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
End of map.
- Code:
maniaplanet:map_end
- Description:
Callback sent when map ends.
- Original Callback:
Native Maniaplanet.EndMap
- Parameters:
map (pyplanet.apps.core.maniaplanet.models.map.Map) – Map instance.
- pyplanet.apps.core.maniaplanet.callbacks.map.map_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Begin of map. (Scripted!)
- Code:
maniaplanet:map_begin
- Description:
Callback sent when map starts (same as begin, but scripted).
- Original Callback:
Script Maniaplanet.StartMap_Start
- Parameters:
time – Time when callback has been sent.
count – Counts of the callback that was sent.
restarted – Is the map restarted.
map (pyplanet.apps.core.maniaplanet.models.map.Map) – Map instance.
- pyplanet.apps.core.maniaplanet.callbacks.map.map_start__end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Begin of map, end of event. (Scripted!)
- Code:
maniaplanet:map_start__end
- Description:
Callback sent when map starts (same as begin, but scripted). End of the event
- Original Callback:
Script Maniaplanet.StartMap_End
- Parameters:
time – Time when callback has been sent.
count – Counts of the callback that was sent.
restarted – Is the map restarted.
map (pyplanet.apps.core.maniaplanet.models.map.Map) – Map instance.
- pyplanet.apps.core.maniaplanet.callbacks.map.playlist_modified = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Maplist changes.
- Code:
maniaplanet:playlist_modified
- Description:
Callback sent when map list changes.
- Original Callback:
Native Maniaplanet.MapListModified
- Parameters:
1 (int) – Current map index.
2 (int) – Next map index.
3 (bool) – Is List Modified.
Player¶
- pyplanet.apps.core.maniaplanet.callbacks.player.player_chat = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Player has been writing a chat entry. When the server writes something we wont inform it in here!
- Code:
maniaplanet:player_chat
- Description:
Callback sent when a player chats.
- Original Callback:
Native Maniaplanet.PlayerChat
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance
text – Text of chat
cmd – Boolean if it’s a command. Be aware, you should use the
command
manager for commands!
- pyplanet.apps.core.maniaplanet.callbacks.player.player_connect = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Player has been connected.
- Code:
maniaplanet:player_connect
- Description:
Callback sent when a player connects and we fetched our data.
- Original Callback:
Native Maniaplanet.PlayerConnect
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance
is_spectator – Boolean determinating if the player joined as spectator.
source – Raw payload, best to not use!
- pyplanet.apps.core.maniaplanet.callbacks.player.player_disconnect = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Player has been disconnected.
- Code:
maniaplanet:player_disconnect
- Description:
Callback sent when a player disconnects.
- Original Callback:
Native Maniaplanet.PlayerDisconnect
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance
reason – Reason of leave
source – Raw payload, best to not use!
- pyplanet.apps.core.maniaplanet.callbacks.player.player_enter_player_slot = <pyplanet.core.events.dispatcher.Signal object>¶
- Signal:
Player enters a player slot.
- Code:
maniaplanet:player_enter_player_slot
- Description:
Player change into a player, is using a player slot.
- Original Callback:
None
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance.
- pyplanet.apps.core.maniaplanet.callbacks.player.player_enter_spectator_slot = <pyplanet.core.events.dispatcher.Signal object>¶
- Signal:
Player enters a spectator slot (not temporary).
- Code:
maniaplanet:player_enter_spectator_slot
- Description:
Player change into a spectator, is using a spectator slot.
- Original Callback:
None
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance.
- pyplanet.apps.core.maniaplanet.callbacks.player.player_info_changed = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Player has changed status.
- Code:
maniaplanet:player_info_changed
- Description:
Callback sent when a player changes from state or information. The callback has been updated in 0.6.0 to include the information retrieved from extracting the flags parameter.
- Original Callback:
Native Maniaplanet.PlayerInfoChanged
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance (COULD BE NONE SOMETIMES!).
player_login – Player login string.
is_spectator – Is player spectator (bool).
is_temp_spectator – Is player temporary spectator (bool).
is_pure_spectator – Is player pure spectator (bool).
auto_target – Player using auto target.
target_id – The target player id (not login!).
target (pyplanet.apps.core.maniaplanet.models.player.Player) – The target player instance or None if not found/none spectating.
flags – Raw flags.
spectator_status – Raw spectator status.
team_id – Team ID of player.
player_id – Player ID (server id).
force_spectator (int) – 1, 2 or 3. Force spectator state
is_referee – Is the player a referee.
is_podium_ready – Is the player podium ready.
is_using_stereoscopy – Is the player using stereoscopy
is_managed_by_other_server – Is the player managed by another server (relaying).
is_server – Is the player one of the servers.
has_player_slot – Has the player a reserved player slot.
is_broadcasting – Is the player broadcasting (steaming) via the in-game stream functionality.
has_joined_game – Is the player ready and has it joined the game as player.
User Interface¶
- pyplanet.apps.core.maniaplanet.callbacks.ui.manialink_answer = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Player has raised an action on the Manialink.
- Code:
maniaplanet:manialink_answer
- Description:
Callback sent when a player clicks on an event of a manialink.
- Original Callback:
Native Maniaplanet.PlayerManialinkPageAnswer
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance
action – Action name
values – Values (in dictionary).
Warning
Don’t use this callback directly, use the abstraction of ``View`` and ``StaticManialink`` to handle events of your manialink!
Other¶
- pyplanet.apps.core.maniaplanet.callbacks.other.bill_updated = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Bill has been updated.
- Code:
maniaplanet:bill_updated
- Description:
Callback sent when a bill has been updated.
- Original Callback:
Native Maniaplanet.BillUpdated
- Parameters:
1 (int) – Bill id.
2 (int) – State.
3 (str) – State name.
4 (int) – Transaction id.
- pyplanet.apps.core.maniaplanet.callbacks.other.channel_progression_end = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Signal sent when channel progression sequence ends.
- Code:
maniaplanet:channel_progression_end
- Description:
Callback sent when the channel progression sequence ends.
- Original Callback:
Script Maniaplanet.ChannelProgression_End
- Parameters:
time – Time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.other.channel_progression_start = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Signal sent when channel progression sequence starts.
- Code:
maniaplanet:channel_progression_start
- Description:
Callback sent when the channel progression sequence starts.
- Original Callback:
Script Maniaplanet.ChannelProgression_Start
- Parameters:
time – Time when callback has been sent.
- pyplanet.apps.core.maniaplanet.callbacks.other.on_echo = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Echo was sent from other Controller/GBXRemote.
- Code:
maniaplanet:on_echo
- Description:
Callback sent when a echo was sent from Controller/GBXRemote.
- Original Callback:
Native Maniaplanet.Echo
Echo(‘Test1’, ‘Test2’) will be reverted to: (‘Test2, Test1’)
- Parameters:
internal – internal
public – public
- pyplanet.apps.core.maniaplanet.callbacks.other.server_chat = <pyplanet.core.events.dispatcher.Signal object>¶
- Signal:
Server send a chat message.
- Code:
maniaplanet:server_chat
- Description:
Custom signal called when the server outputs a message.
- Origin Callback:
None (via Chat callback).
- pyplanet.apps.core.maniaplanet.callbacks.other.server_password = <pyplanet.core.events.dispatcher.Signal object>¶
- Signal:
Server player or spectator password changed
- Code:
maniaplanet:server_password
- Description:
Custom signal called when the password has been changed with PyPlanet.
- Origin Callback:
None.
- Parameters:
password (str) – String with the new password.
kind (str) – Kind of password, could be ‘player’ or ‘spectator’.
- pyplanet.apps.core.maniaplanet.callbacks.other.vote_updated = <pyplanet.core.events.callback.Callback object>¶
- Signal:
Vote has been updated.
- Code:
maniaplanet:vote_updated
- Description:
Callback sent when a call vote has been updated.
- Original Callback:
Native Maniaplanet.VoteUpdated
- Parameters:
player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance
state – State name
cmd_name – Command name
cmd_param – Parameter given with command.