Scripts For Admins: Difference between revisions

== Parameters Key ==

{| class="wikitable"

! Type !! Examples !! Explanation

|-

| Required || ''<param>'' || Surrounded by angled brackets. Cannot be omitted.

|-

| Optional || ''[<param>]'' || Surrounded by angled brackets inside square brackets. May be omitted.

|-

| Required Verbatim || ''param'' || Must be typed exactly as displayed (e.g.: "param"). Cannot be omitted.

|-

| Optional Verbatim || ''[param]'' || Must be typed exactly as displayed. May be omitted.

|-

| Multiple || ''* <nowiki>{paramA | paramB}</nowiki><br>* <nowiki>{paramA | paramB <paramC1> [<paramC2>]}</nowiki>'' || Surrounded by curly brackets, divided by pipe (<nowiki>|</nowiki>). Any one of the parameters<br>or parameter groups may be used.

|-

| Ellipsis || ''[...]'' || Signifies that there can be an indefinite number of parameters.

|}

=== Admin Portals ===

{{Script|AdminPortal|

desc=Creates a portal at the admin's position.|

params=[<name>] <destination-zone> <destination-ref>|

:: '''name:''' ''(optional)'' Name of new portal.

:: '''destination-zone:''' Target zone where player is teleported.

:: '''destination-ref:''' Portal reference where player is teleported.}}

{{Script|AdminPortal|

desc=Creates a portal.|

params=<name> <destination-zone> <destination-ref> [level <min-level> <max-level> [<reject-message>]]|

:: '''name:''' Name of new portal at the admin's position.

:: '''destination-zone:''' Target zone where player is teleported.

:: '''destination-ref:''' Portal reference where player is teleported.

:: '''level:''' If used, portal will check player level before teleporting.

:: '''min-level:''' Minimum level player must be to use portal.

:: '''max-level:''' Maximum level of player to use portal.

:: '''reject-message:''' Message shown to player when they don't meet the level requirements.}}

=== Admin Signs ===

; /script AdminSign.class ''<zone> <x> <y> <text>''

: Description:

:: Places a sign saying ''text'' in the ''zone'' at (''x'', ''y''). The first three parameters can be "-" to place the sign next to the admin.

; /script AdminSign.class ''list''

: Description:

:: Lists all signs created by admins

; /script AdminSign.class ''del <signnumber>''

: Description:

:: Removes the sign with that number (see list)

: Parameters:

:: '''signnumber:''' Integer sign identifier.

This Script summons an NPC who will collect and pay bets at a raid.

; /script BetManager.class ''accept <opponent1> <opponent2> [...]''

: Description:

:: Summons the NPC and let it accept bets on ''<opponent1>'', ''<opponent2>'', ...

: Parameters:

:: All parameters are names of players.

; /script BetManager.class ''action''

: Description:

:: The game master started the action closing the betting time.

; /script BetManager.class ''winner <opponent>''

: Description:

:: After the game master has to tell the NPC who won.

: Parameters:

:: '''opponent:''' Name of target player.

; /script EntitySearch.class ''cname <creatureName>''

: Description:

:: Show the number of the specified ''<creatureName>'' respawn points for each zone. Zones with zero are not shown

: Parameters:

:: '''creatureName:''' Name of target creature.

; /script EntitySearch.class ''nonrespawn''

: Description:

:: Shows the locations of all creatures that don't respawn, for example creatures that were summoned by a GM, deathmatch creatures, etc. Sheep and pets are ignored.

; /script EntitySearch.class zname ''<partialZoneName>''

: Description:

:: Shows all zone names that contain ''<partialZoneName>'' and shows all the creature respawn points in each of those zones.

: Parameters:

:: '''partialZoneName:''' Name of target zone.

=== Server Reset ===

; /script ServerReset.class

: Description:

:: Use it in an ''emergency'' to shut down the server. If it is started in a loop, it will come back up otherwise it will stay down. If it is possible, please warn the players to logout and give them some time. Please note that it kills the server the hard way without doing a clean shutdown.

=== NPC Management ===

: Description:

:: Lists all npcs and their position.

; /script NPCShout.class ''<npc> <text>''

: Description:

:: Send a notification to all players using an NPC name.

: Parameters:

:: '''npc:''' Name of target NPC.

:: '''text:''' Message that players will receive.

; /script NPCShoutZone.class ''<npc> { <zone> | - } <text>''

: Description:

:: Send a notification to all players in a specific zone using an NPC name.

: Parameters:

:: '''npc:''' Name of target NPC.

:: '''zone:''' Name of target zone.

:: '''-:''' Target zone will be your current zone.

:: '''text:''' Message that players will receive.

: Description:

:: Summons Maria, who sells food&drinks. Put her away after use, by teleporting ''yourself'' to int_admin_playground and executing the script again or use -unload

=== Alter Player Loot Count ===

Intended for testing purposes.

; /script AlterLoot.class ''<player> <count> <item>''

: Description:

:: Alters number of loots a player has for an item.

: Parameters:

:: '''player:''' Name of target player.

:: '''count:''' Amount to set.

:: '''item:''' Name of item.

; /script AlterLoot.class !help

: Description:

:: Shows help information.

=== Alter Quest State ===

; /script AlterQuest.class ''<player> <questid> [<state>]''

: Description:

:: Manipulates the quest state of a player.

: Parameters:

:: '''player:''' Name of target player.

:: '''questid:''' Quest string identifier.

:: '''state:''' ''(optional)'' String state to set quest. If omitted, quest will be removed from player.

; /script DropPlayerItems.class ''<player> [<amount>] <item>''

=== Features ===

{{Script|DisableFeature|

desc=Disables a feature, like keyring, for a player.|

params=<player> <feature>|

:: '''player:''' Name of target player.

:: '''feature:''' Feature to be disabled.}}

{{Script|EnableFeature|

desc=Enables a feature, like keyring, for a player.|

params=<player> <feature>|

:: '''player:''' Name of target player.

:: '''feature:''' Feature to be enabled.}}

=== List Raids ===

{{Script|ListRaids}}

: ''<span style="color:darkred;">instructions coming soon</span>''

=== Raids ===

{{Script|AdosWildlifeRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|AngelRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|AnimalRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|BarbarianRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|BeholderRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|BlordroughRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|ChaosRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|CreateRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|DragonRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|DrowRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|DwarfRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|ElementalRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|ElfRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|FarmRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|FrogmanSheepmanRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|GnomeRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|ImperialRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|KoboldRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|LichRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|OniRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|OrcRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''

{{Script|ZombieRaid}}

: ''<span style="color:darkred;">instructions coming soon</span>''