Shootmania¶

Base¶

Weapons:	[1-Laser, 2-Rocket, 3-Nucleus, 5-Arrow]

pyplanet.apps.core.shootmania.callbacks.base.action_custom_event = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Handle Action Custom Event.
Code:	`shootmania:action_custom_event`
Description:	Callback sent when an action triggers a custom event.
	Script Shootmania.Event.OnActionCustomEvent
Parameters:	time – Time of server when callback is sent. shooter (pyplanet.apps.core.maniaplanet.models.player.Player) – Shooter player instance if any victim (pyplanet.apps.core.maniaplanet.models.player.Player) – Victim player instance if any actionid – Action Identifier. * – Any other params, like `param1`, `param2`, etc…

pyplanet.apps.core.shootmania.callbacks.base.action_event = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Handle Action Event.
Code:	`shootmania:action_event`
Description:	Callback sent when an action triggers an event.
	Script Shootmania.Event.OnActionEvent
Parameters:	time – Time of server when callback is sent. login – Player login player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance. action_input – Action input.

pyplanet.apps.core.shootmania.callbacks.base.on_armor_empty = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Armor empty, player eliminated.
Code:	`shootmania:on_armor_empty`
Description:	Callback sent when a player is eliminated.
	Script Shootmania.Event.OnArmorEmpty
Parameters:	shooter (pyplanet.apps.core.maniaplanet.models.player.Player) – shooter, Player instance time – Time of server when callback is sent. weapon – Weapon number. victim (pyplanet.apps.core.maniaplanet.models.player.Player) – victim, Player instance distance – Distance between victim and shooter. shooter_position – Position of shooter. victim_position – Position of victim.

pyplanet.apps.core.shootmania.callbacks.base.on_capture = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Landmark has been captured
Code:	`shootmania:on_capture`
Description:	Callback sent when a landmark is captured.
	Script Shootmania.Event.OnCapture

time=source[‘time’], players=players, landmark=source[‘landmark’]

Parameters:	time – Time of server when callback is sent. players (pyplanet.apps.core.maniaplanet.models.player.Player[]) – Player list (instances). landmark – Landmark information, raw!

pyplanet.apps.core.shootmania.callbacks.base.on_command = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	On Command
Code:	`shootmania:on_command`
Description:	Callback sent when a command is executed on the server.
	Script Shootmania.Event.OnCommand
Parameters:	time – Time of server when callback is sent. name – Name of the command value (dict) – Value in dictionary of the command.

pyplanet.apps.core.shootmania.callbacks.base.on_default = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	On Default Event
Code:	`shootmania:on_default`
Description:	Callback sent when a old event or default event has been fired.
	Script Shootmania.Event.Default
Parameters:	time – Time of server when callback is sent. type – Name of the command

pyplanet.apps.core.shootmania.callbacks.base.on_fall_damage = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Fall Damage
Code:	`shootmania:on_fall_damage`
Description:	Callback sent when a player suffers fall damage.
	Script Shootmania.Event.OnFallDamage
Parameters:	time – Time of server when callback is sent. victim (pyplanet.apps.core.maniaplanet.models.player.Player) – victim, Player instance

pyplanet.apps.core.shootmania.callbacks.base.on_hit = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player hit.
Code:	`shootmania:on_hit`
Description:	Callback sent when a player is hit.
	Script Shootmania.Event.OnHit
Parameters:	shooter (pyplanet.apps.core.maniaplanet.models.player.Player) – shooter, Player instance time – Time of server when callback is sent. weapon – Weapon number. victim (pyplanet.apps.core.maniaplanet.models.player.Player) – victim, Player instance damage – Damage done. points – Points scored by hit. distance – Distance between victim and shooter. shooter_position – Position of shooter. victim_position – Position of victim.

pyplanet.apps.core.shootmania.callbacks.base.on_near_miss = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Near Miss.
Code:	`shootmania:on_near_miss`
Description:	Callback sent when a player dodges a projectile.
	Script Shootmania.Event.OnNearMiss
Parameters:	shooter (pyplanet.apps.core.maniaplanet.models.player.Player) – shooter, Player instance time – Time of server when callback is sent. weapon – Weapon number. victim (pyplanet.apps.core.maniaplanet.models.player.Player) – victim, Player instance distance – Distance between victim and shooter. shooter_position – Position of shooter. victim_position – Position of victim.

pyplanet.apps.core.shootmania.callbacks.base.on_shoot = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player shoot.
Code:	`shootmania:on_shoot`
Description:	Callback sent when a player shoots.
	Script Shootmania.Event.OnShoot
Parameters:	shooter (pyplanet.apps.core.maniaplanet.models.player.Player) – Shooter, Player instance time – Time of server when callback is sent. weapon – Weapon number.

pyplanet.apps.core.shootmania.callbacks.base.on_shot_deny = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player denies a projectile.
Code:	`shootmania:on_shot_deny`
Description:	Callback sent when a player denies a projectile.
	Script Shootmania.Event.OnShotDeny
Parameters:	time – Time of server when callback is sent. shooter (pyplanet.apps.core.maniaplanet.models.player.Player) – shooter, Player instance victim (pyplanet.apps.core.maniaplanet.models.player.Player) – victim, Player instance shooter_weapon – Weapon number of shooter. victim_weapon – Weapon number of victim that denied the shot. distance – Distance between victim and shooter. shooter_position – Position of shooter. victim_position – Position of victim.

pyplanet.apps.core.shootmania.callbacks.base.player_added = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	On player added.
Code:	`shootmania:player_added`
Description:	Callback sent when a player joins the server.
	Script Shootmania.Event.OnPlayerAdded
Parameters:	time – Time of server when callback is sent. player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance team – Team nr. language – Language code, like ‘en’. ladder_rank – Current ladder rank. ladder_points – Current ladder points.

pyplanet.apps.core.shootmania.callbacks.base.player_removed = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	On player removed.
Code:	`shootmania:player_removed`
Description:	Callback sent when a player leaves the server.
	Script Shootmania.Event.OnPlayerRemoved
Parameters:	time – Time of server when callback is sent. login – Player login string player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance.

pyplanet.apps.core.shootmania.callbacks.base.player_request_action_change = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player requests action change.
Code:	`shootmania:player_request_action_change`
Description:	Callback sent when a player requests to use another action.
	Script Shootmania.Event.OnPlayerRequestActionChange
Parameters:	time – Time of server when callback is sent. player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance. action_change – Can be -1 (request previous action) or 1 (request next action)

pyplanet.apps.core.shootmania.callbacks.base.player_request_respawn = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	On player request respawn.
Code:	`shootmania:player_request_respawn`
Description:	Callback sent when a player presses the respawn button.
	Script Shootmania.Event.OnPlayerRequestRespawn
Parameters:	time – Time of server when callback is sent. login – Player login string player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance.

pyplanet.apps.core.shootmania.callbacks.base.player_throws_object = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player Throws an object.
Code:	`shootmania:player_touch_object`
Description:	Callback sent when a player throws an object.
	Script Shootmania.Event.OnPlayerThrowsObject
Parameters:	time – Time of server when callback is sent. player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance. object_id – Object Identifier. model_id – Model identifier. model_name – Model name.

pyplanet.apps.core.shootmania.callbacks.base.player_touches_object = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player Touches Object.
Code:	`shootmania:player_touches_object`
Description:	Callback sent when a player touches an object.
	Script Shootmania.Event.OnPlayerTouchesObject
Parameters:	time – Time of server when callback is sent. player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance. object_id – Object Identifier. model_id – Model identifier. model_name – Model name.

pyplanet.apps.core.shootmania.callbacks.base.player_triggers_sector = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player Triggers Sector.
Code:	`shootmania:player_triggers_sector`
Description:	Callback sent when a player triggers a sector.
	Script Shootmania.Event.OnPlayerTriggersSector
Parameters:	time – Time of server when callback is sent. player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance. sector_id – Sector Identifier.

pyplanet.apps.core.shootmania.callbacks.base.scores = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Score callback, called after the map. (Around the podium time).
Code:	`shootmania:scores`
Description:	Teams and players scores.
	Script Shootmania.Scores
Parameters:	players (list) – Player score payload. Including player instance etc. teams (list) – Team score payload. winner_team – The winning team. use_teams – Use teams. winner_player – The winning player. section – Section, current progress of match. Important to check before you save results!!

Elite¶

Victory Types:	1 = time limit reached, 2 = capture, 3 = attacker eliminated, 4 = defenders eliminated.

pyplanet.apps.core.shootmania.callbacks.elite.turn_end = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Elite turn start.
Code:	`shootmania:elite_turn_end`
Description:	Information about the ending turn.
	Script Shootmania.Elite.EndTurn
Parameters:	victory_type – Describe how the turn was won. 1 = time limit, 2 = capture, 3 = attacker eliminated, 4 = defenders eliminated

pyplanet.apps.core.shootmania.callbacks.elite.turn_start = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Elite turn start.
Code:	`shootmania:elite_turn_start`
Description:	Information about the starting turn.
	Script Shootmania.Elite.StartTurn
Parameters:	attacker (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance of attacker. defenders (pyplanet.apps.core.maniaplanet.models.player.Player[]) – List with player instances of defenders.

Joust¶

pyplanet.apps.core.shootmania.callbacks.joust.player_reload = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player reloads its weapon and capture pole.
Code:	`shootmania:joust_player_reload`
Description:	Callback sent when a player capture a pole to reload its weapons.
	Script Shootmania.Joust.OnReload
Parameters:	login – Player login. player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance.

pyplanet.apps.core.shootmania.callbacks.joust.results = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	End of round with results of Joust round.
Code:	`shootmania:joust_results`
Description:	Callback sent at the end of the round with the scores of the two players.
	Script Shootmania.Joust.RoundResult
Parameters:	players (list) – Player score list, contains player + score.

pyplanet.apps.core.shootmania.callbacks.joust.selected_players = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Round starts with selected players.
Code:	`shootmania:joust_selected_players`
Description:	Callback sent at the beginning of the round with the logins of the players selected to play the round.
	Script Shootmania.Joust.SelectedPlayers
Parameters:	players (pyplanet.apps.core.maniaplanet.models.player.Player[]) – Player list (instances).

Royal¶

pyplanet.apps.core.shootmania.callbacks.royal.player_score_points = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player score points.
Code:	`shootmania:royal_player_score_points`
Description:	Callback sent when a player scores some points.
	Script Shootmania.Royal.Points
Parameters:	player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance. type – Type of score, like ‘Pole’, ‘Hit’, or ‘Survival’. points – Points that the player gains.

pyplanet.apps.core.shootmania.callbacks.royal.player_spawn = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	Player spawns.
Code:	`shootmania:royal_player_spawn`
Description:	Callback sent when a player is spawned.
	Script Shootmania.Royal.PlayerSpawn
Parameters:	player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance.

pyplanet.apps.core.shootmania.callbacks.royal.results = <pyplanet.core.events.callback.Callback object>¶

Original Callback:
Signal:	End of round with the winner of the Royal round.
Code:	`shootmania:royal_results`
Description:	Callback sent at the end of the round with the player instance of the winner.
	Script Shootmania.Royal.RoundWinner
Parameters:	player (pyplanet.apps.core.maniaplanet.models.player.Player) – Player instance that won the round.