Create a free account to remove all ad content.

Author Topic:  Script Command Documentation  (Read 31890 times)

0 Members and 1 Guest are viewing this topic.

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #60 on: April 19, 2015, 08:26:44 AM »
Clan: Assigns the player to a clan or removes them from a clan.

Clan [name|remove]

[name] - The name of the clan to assign the player to.
[remove] - Remove the player from whichever clan they are assigned to.

Examples:

Clan [Team1]
Assigns the player to the clan called Team1.

Clan [remove]
Removes the player from whichever clan they have previously been assigned to.
« Last Edit: July 28, 2015, 08:35:55 PM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #61 on: April 19, 2015, 08:40:57 AM »
IsClan: Queries if the player is a member of a clan.

IsClan [name] [true|false]

[name] - The name of the clan.

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #62 on: April 19, 2015, 09:16:50 AM »
Sound: Play a sound.

Sound [name] [x,y,z] [volume] [range] [loop, delay=x, count=x]
Sound [name] [x1,y1,z1] [x2,y2,z2] [volume] [loop, delay=x, count=x]
Sound [name] [zone] [volume] [loop, delay=x, count=x]

Sound [name] [x,y,z] [delete]
Sound [name] [x1,y1,z1] [x2,y2,z2] [delete]
Sound [name] [zone] [delete]

[name] - The name of the sound. Valid names listed below.

[x,y,z] - The coordinate of the source of the sound.

[x1,y1,z1] [x2,y2,z2] - Zone for the sound to play in.

[zone] - Zone for the sound to play in.

[delete] - Delete a previously created sound. The name and coordinate(s) or zone must be supplied. Sounds that omit the loop parameter do not need to be deleted, they delete themselves after playing. Sounds that specify a loop count do not need to be deleted, they delete themselves after playing the number of loops specified. All other sounds must be deleted with the [delete] parameter if you want them to stop.

[volume] - A value between 1 and 100. 1 = very low volume, 100 = full volume. If ommitted then volume defaults to 100.

[range] - A value between 1 and 1000. The defines how far the sound can be heard from the source location. If ommitted then range defaults to 32. This value is ignored if it used for a zoned sound.

[loop, delay=x, count=x] - If the loop parameter is omitted the sound will play once and then stop.
delay=x where x is the number of milliseconds to delay between each loop. If omitted it defaults to 0 (zero) no delay.
count=x where x is the number of times to loop the sound. If omitted the sound will loop continuously until it is deleted.

Examples:

Sound [birds] [100,200,150]
Plays the birds sound at location [100,200,150], at full volume, with a range of 32 blocks from the source location. The sound will not loop.

Sound [brook] [100,200,150] [50] [100]
Plays the birds sound at location [100,200,150], at half volume, with a range of 100 blocks from the source location. The sound will not loop.

Sound [brook] [100,200,150] [delete]
Delete the brook sound that is currently playing at location [100,200,150].

Sound [birds] [100,200,150] [120, 220, 170]
Plays the birds sound inside the bound of [100,200,150] [120,220,170], at full volume. The sound will not loop.

Sound [brook] [100,200,150] [120, 220, 170] [50]
Plays the brook sound inside the bound of [100,200,150] [120,220,170], at half volume. The sound will not loop.

Sound [brook] [100,200,150] [120,220,170] [delete]
Delete the brook sound that is currently playing inside the bound of [100,200,150] [120,220,170].

Sound [birds] [Forest]
Plays the birds sound inside the bound of the zone named Forest, at full volume. The sound will not loop.

Sound [brook] [Forest] [50]
Plays the brook sound inside the bound of the zone named Forest, at half volume. The sound will not loop.

Sound [brook] [Forest] [delete]
Delete the brook sound that is currently playing inside the zone named Forest.

Sound [brook] [Forest] [loop]
Plays the brook sound inside the bound of the zone named Forest, at full volume. The sound will loop continuously until deleted with no delay between loops.

Sound [brook] [Forest] [loop, delay=2500]
Plays the brook sound inside the bound of the zone named Forest, at full volume. The sound will loop continuously until deleted with a 2500 millisecond (2.5 second) delay between loops.

Sound [brook] [Forest] [loop, count=5]
Plays the brook sound inside the bound of the zone named Forest, at full volume. The sound will loop 5 times with no delay between loops and then stop.

Sound [brook] [Forest] [loop, delay=1000, count=2]
Plays the brook sound inside the bound of the zone named Forest, at full volume. The sound will loop twice with a 1 second delay between loops and then stop.

Current Sound Names:
Birds
Light Cave Water
Medium Cave Water
Dungeon
Factory
Forest
Gentle Sea on Beach
Stream
Meadow
Rain or Waterfall
Brook
Wind
Tumbleweed Wind
Gear and Winch
Town Bells
Blacksmith
Boiling Water
Marsh at Night
Timer
Fire
Rooster
Mechanical
Alien Drone
Eerie Squalls
Traffic Jam
Stressed Metal
Small Farm
Snoring
Insect Buzz
Nuclear Meltdown
Noisy Crowd
High Alert
Danger Imminent
Door Bell
Thunder
« Last Edit: April 21, 2015, 09:08:24 PM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #63 on: May 27, 2015, 11:07:02 PM »
Health: Manipulate a players (or target mob) current Health points.

Health [qty] [milliseconds] [duration|history] [delete] [name=]

[qty] - The number of points to add/subtract from the players current health. A negative number will lower the players health (cause damage).

[milliseconds] - Apply this effect every # of milliseconds. If this parameter is omitted, the effect is a one off. Minimum value is 16.

[duration|history] - Apply this effect for [duration] milliseconds then automatically stop. Only valid if [milliseconds] is also specified. If a [milliseconds] parameter is included, but this parameter is omitted, then the effect runs indefinitely.

An alternative to duration is a history key. The effect will be applied while the player has that history, and the player must have the history at the time of this command for the effect to be added to the players effect stack, so if the player only gets the history after this command is executed, the effect will not apply.

[delete] - Delete the effect immediately. Only named effects can be deleted.

[name=] - The name of the effect. If you require to delete a specific effect, it must be named.

Health commands can be stacked and are accumulative.

e.g. if you run these commands:

Health [20] [1000]
Health [-15] [1000]
The accumulative effect is +5 health points per second.

*Note: If the script [player] context is currently [target] and the target is a mob, this command will work on the target mob.

Examples:

Health [10]
Add 10 health points to the player. This is a one off.

Health [-20]
Subtract 20 health points from the player. This is a one off. If the players health reaches zero, they will die.

Health [-20] [1000]
Subtract 20 health points from the player every second, for an indefinate period of time.

Health [-2] [500] [10000]
Subtract 2 health points from the player every half second. Apply this effect for 10 seconds then stop.

Health [-2] [500] [challenge]
Subtract 2 health points from the player every half second. Apply this effect for as long as the player has the 'challenge' history. If the player does not have the challenge history at the time this command is executed, the effect will not be added.

Health [5] [2000] [name=booster]
Add 5 health points to the player every 2 seconds. Name the effect 'booster'.

Health [delete] [booster]
Delete an existing health effect which was named [booster].

Health [delete]
Delete all existing health effects on the player.
« Last Edit: November 30, 2015, 07:08:30 AM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #64 on: May 27, 2015, 11:10:00 PM »
Equip: Equip: Forces the player to equip an item if they have it in their inventory.

Equip [left|right|body] [item]

[left|right|body] - left hand, right hand, or body slot. Omit to use default. If body is used, the item will be equipped to the appropriate body slot.

[item] - The item to equip.

Note: Hosts ought to use this command moderately and only for controlled scenario's. Players won't like their equips being changed outside their control and may leave your world as a consequence.
« Last Edit: July 28, 2015, 08:39:49 PM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #65 on: May 27, 2015, 11:11:39 PM »
IsEquipped: Queries if the player has the item equipped.

IsEquipped [left|right|body] [item] [true|false]

[left|right|body] - left hand, right hand, or body slot. Omit to use default. If body is used, the appropriate body slot is used for the query.

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #66 on: May 27, 2015, 11:13:28 PM »
IsMobCount: Queries the number of mobs in an area.

IsMobCount [mobtype] [compare] [count]
IsMobCount [zone] [mobtype] [compare] [count]
IsMobCount [x,y,z] [radius] [mobtype] [compare] [count]
IsMobCount [x,y,z] [x,y,z] [mobtype] [compare] [count]

Examples:

IsMobCount [>] [2]
Returns true if there are at least 3 mobs in the world.

IsMobCount [zombie] [>] [1]
Returns true if there are more than 1 zombies in the world.

IsMobCount [township] [>] [0]
Returns true if there is at least 1 remote player inside the township zone.

IsMobCount [township] [>] [0]
Returns true if there is at least 1 mob inside the township zone.

IsMobCount [township] [orc] [>] [0]
Returns true if there is at least 1 orc inside the township zone.
« Last Edit: August 12, 2016, 05:03:47 AM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #67 on: June 14, 2015, 03:55:22 AM »
SetReach: Sets the distance players can reach (target) blocks.

SetReach [distance] [player|clan]

[distance] - A value from 1 to 15. If distance is omitted, the default value is used.

Examples:

SetReach [10]
Sets the reach to 10 for all players in the session.

SetReach [5] [player]
Sets the reach to 5 only for the player who activated the script.

SetReach [4] [clan]
Sets the reach to 4 for all players in the clan of the player who activated the script.

SetReach
Sets the reach to the default distance for all players in the session.

SetReach [player]
Sets the reach to the default distance for the player who activated the script.
« Last Edit: June 16, 2015, 07:19:14 PM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #68 on: June 14, 2015, 03:56:09 AM »
OpenBlock: Opens the standard interface screen for container blocks.

OpenBlock [x,y,z]

[x,y,z] - The coordinate of the block to open.

Examples:

OpenBlock [100,200,300]
Opens the block and presents the Block interface to the player.

Blocks that can be opened:

Crate
Chest
Safe
LockedChest
BookCase
Furnace
ItemShop
BlockShop
Workbench
Book
« Last Edit: June 16, 2015, 07:10:56 PM by Craig »

Craig

  • Developer
  • Extreme Member
  • *
  • Posts: 6655
  • Dig Deep
    • View Profile
    • Twitter
  • Steam: tota1miner
Re: Script Command Documentation
« Reply #69 on: June 14, 2015, 04:03:24 AM »
IsBlockEdited: Queries if the block at a location has been edited.

IsBlockEdited [x,y,z] [true|false]

Examples:

IsBlockEdited [150,200,300]
IsBlockEdited [150,200,300] [true]
Returns true if the block at location 150,200,300 has been edited.

IsBlockEdited [150,200,300] [false]
Returns true if the block at location 150,200,300 has not been edited. i.e. it is still in it's naturally generated state.
« Last Edit: June 16, 2015, 07:14:22 PM by Craig »