C# Class Aura.Channel.Scripting.Scripts.DungeonScript

Inheritance: IScript
Datei anzeigen Open project: aura-project/aura

Public Methods

Method Description
Init ( ) : bool

Called when the script is initially created.
OnBoss ( Dungeon dungeon ) : void

Called when the boss door opens.
OnBossDeath ( Dungeon dungeon, Creature deadBoss, Creature killer ) : void

Called when one of the boss monsters dies.
OnCleared ( Dungeon dungeon ) : void

Called when the boss was killed.
OnCreation ( Dungeon dungeon ) : void

Called when the dungeon was just created.
OnLeftEarly ( Dungeon dungeon, Creature creature ) : void

Called when a player leaves a dungeon via the first statue, logging out, or similar.
OnPartyEntered ( Dungeon dungeon, Creature creature ) : void

Called once, when the entire initial party has entered the dungeon's lobby.
OnPlayerEntered ( Dungeon dungeon, Creature creature ) : void

Called whenever a player enters the dungeon's lobby.
OnPlayerEnteredFloor ( Dungeon dungeon, Creature creature, int floor ) : void

Called when a creature enters a floor region. The floor ids start at 1.
OnRpCharacterCreated ( Dungeon dungeon, RpCharacter rpCharacter ) : void

Called after an RP character was created, but before the player is warped into the dungeon.

Allows changes to the RP character, which are created based on actor data.

OnSectionCleared ( Dungeon dungeon, int floor, int section ) : void

Called when all puzzles of a section have been solved.
Route ( Creature creature, Item item, string &dungeonName ) : bool

Changes dungeonName depending on the item, returns true if routing was successful, if not, the dungeon was invalid.

Method Details

Init() public method

Called when the script is initially created.
public Init ( ) : bool
return bool

OnBoss() public method

Called when the boss door opens.
public OnBoss ( Dungeon dungeon ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
return void

OnBossDeath() public method

Called when one of the boss monsters dies.
public OnBossDeath ( Dungeon dungeon, Creature deadBoss, Creature killer ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
deadBoss Aura.Channel.World.Entities.Creature
killer Aura.Channel.World.Entities.Creature
return void

OnCleared() public method

Called when the boss was killed.
public OnCleared ( Dungeon dungeon ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
return void

OnCreation() public method

Called when the dungeon was just created.
public OnCreation ( Dungeon dungeon ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
return void

OnLeftEarly() public method

Called when a player leaves a dungeon via the first statue, logging out, or similar.
public OnLeftEarly ( Dungeon dungeon, Creature creature ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
creature Aura.Channel.World.Entities.Creature
return void

OnPartyEntered() public method

Called once, when the entire initial party has entered the dungeon's lobby.
public OnPartyEntered ( Dungeon dungeon, Creature creature ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
creature Aura.Channel.World.Entities.Creature The last creature that entered.
return void

OnPlayerEntered() public method

Called whenever a player enters the dungeon's lobby.
public OnPlayerEntered ( Dungeon dungeon, Creature creature ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
creature Aura.Channel.World.Entities.Creature The creature that entered.
return void

OnPlayerEnteredFloor() public method

Called when a creature enters a floor region. The floor ids start at 1.
public OnPlayerEnteredFloor ( Dungeon dungeon, Creature creature, int floor ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
creature Aura.Channel.World.Entities.Creature
floor int
return void

OnRpCharacterCreated() public method

Called after an RP character was created, but before the player is warped into the dungeon.
Allows changes to the RP character, which are created based on actor data.
public OnRpCharacterCreated ( Dungeon dungeon, RpCharacter rpCharacter ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
rpCharacter Aura.Channel.World.Entities.RpCharacter
return void

OnSectionCleared() public method

Called when all puzzles of a section have been solved.
public OnSectionCleared ( Dungeon dungeon, int floor, int section ) : void
dungeon Aura.Channel.World.Dungeons.Dungeon
floor int The floor, starting at 1 (lobby is ignored).
section int The section, starting at 1.
return void

Route() public method

Changes dungeonName depending on the item, returns true if routing was successful, if not, the dungeon was invalid.
public Route ( Creature creature, Item item, string &dungeonName ) : bool
creature Aura.Channel.World.Entities.Creature
item Item
dungeonName string
return bool