Updated Perl API (markdown)

TurmoilToad
2018-11-20 21:56:52 -05:00
parent c7b09deceb
commit 987de7eb71
+196 -12
@@ -301,19 +301,203 @@ if ($text!~/Hail|Hi|Hello/i) # Will check if the text does not contain "Hail", "
* A full list can always be found in the EQEmu source [https://github.com/EQEmu/Server/blob/master/zone/questmgr.cpp](https://github.com/EQEmu/Server/blob/master/zone/questmgr.cpp) * A full list can always be found in the EQEmu source [https://github.com/EQEmu/Server/blob/master/zone/questmgr.cpp](https://github.com/EQEmu/Server/blob/master/zone/questmgr.cpp)
### AssignGroupToInstance
      **Parmeter:**
      uint16 instance_id
      **Usage:**
      Assigns a group to an instance.
      **Example:**
```perl
#:: Create a scalar variable to store instance_id--GetInstanceID returns int
my $Instance = quest::GetInstanceID($zonesn, $instanceversion);
quest::AssignGroupToInstance($Instance);
```
### AssignRaidToInstance
      **Parmeter:**
      uint16 instance_id
      **Usage:**
      Assigns a raid to an instance.
      **Example:**
```perl
#:: Create a scalar variable to store instance_id--GetInstanceID returns int
my $Instance = quest::GetInstanceID($zonesn, $instanceversion);
quest::AssignRaidToInstance($Instance);
```
### AssignToInstance
      **Parameter:**
      uint16 instance_id
      **Usage:**
      Assigns a single player to an instance.
      **Example**
```perl
#:: Create a scalar variable to store instance_id--GetInstanceID returns int
my $Instance = quest::GetInstanceID($zonesn, $instanceversion);
quest::AssignToInstance($Instance);
```
### ChooseRandom
      **Parameter(s):**
      option1, option2, option3...
      **Usage:**
      Returns one of the items listed in its arguments randomly.
      **Example:**
```perl
#:: Choose a random reward: 1001 - Cloth Cap, 1004 - Cloth Shirt, 1011 - Cloth Pants
quest::summonitem(quest::ChooseRandom(1001, 1004, 1011);
```
### CreateInstance
      **Parameter(s):**
      string zone_name, uint16 version, uint32 duration
      **Usage:**
      Creates an instance in the given zone using specified version and duration.
      **Example:**
```perl
quest::CreateInstance("mirb", 50, 10800);
```
### DestroyInstance
      **Parameter(s):**
      uint16 instance_id
      **Usage:**
      Destroys the given instance.
      **Example:**
```perl
quest::DestroyInstance(50);
```
### FlagInstanceByGroupLeader
      **Parameter(s):**
      uint32 zone, uint16 version
      **Usage:**
      Assigns the group leader's instance to a player
      **Example:**
```perl
#:: Zone 237 (mirb), instance 50
quest::FlagInstanceByGroupLeader(237,50);
```
### FlagInstanceByRaidLeader
      **Parameter(s):**
      uint32 zone, uint16 version
      **Usage:**
      Assigns the raid leader's instance to a player
      **Example:**
```perl
#:: Zone 237 (mirb), instance 50
quest::FlagInstanceByRaidLeader(237,50);
```
### FlyMode
      **Parameter(s):**
      uint8 mode [0-3]
      **Usage:**
      Sets flymode for player where 0 = Off, 1 = On, 2 = Levitate.
      **Example:**
```perl
#:: Turn fly mode on
quest::FlyMode(1);
```
### GetCharactersInInstance
      **Parameter(s):**
      uint16 instance_id)
      **Usage:**
      Returns a hash of character id and instance id
      **Example:**
```perl
#:: Instance ID 50
quest::GetCharactersInInstance(50); #:: Returns 50,123456
```
### GetInstanceID
      **Parameter(s):**
      string zone_name, uint16 version
      **Usage:**
      Returns the instance id of the given zone/verison.
      **Example**
```perl
#:: Create a scalar variable to store instance_id
my $Instance = quest::GetInstanceID($zonesn, $instanceversion); #:: Returns uint16
quest::AssignToInstance($Instance);
```
### GetInstanceTimer()
      **Parameter(s):**
      None.
      **Usage:**
      Returns the timer for the instance.
      **Example**
```perl
quest::GetInstanceTimer(); #:: Returns uint32
```
(work in progress)
```perl ```perl
quest::AssignGroupToInstance(uint16 instance_id)
quest::AssignRaidToInstance(uint16 instance_id)
quest::AssignToInstance(uint16 instance_id)
quest::ChooseRandom(option1, option2, option3, option4, option5...[no limit])
quest::CreateInstance(string zone_name, uint16 version, uint32 duration)
quest::DestroyInstance(int id)
quest::FlagInstanceByGroupLeader(uint32 zone, uint16 version)
quest::FlagInstanceByRaidLeader(uint32 zone, uint16 version)
quest::FlyMode(uint8 mode [0-3])
quest::GetCharactersInInstance(uint16 instance_id)
quest::GetInstanceID(string zone_name, uint16 version)
quest::GetInstanceTimer()
quest::GetInstanceTimerByID(uint16 instance_id) quest::GetInstanceTimerByID(uint16 instance_id)
quest::GetSpellResistType(uint32 spell_id) quest::GetSpellResistType(uint32 spell_id)
quest::GetSpellTargetType(uint32 spell_id) quest::GetSpellTargetType(uint32 spell_id)