C# 클래스 Aura.Channel.Scripting.Scripts.GameEventScript

Script for in-game events, like Double Rainbow.
상속: GeneralScript
파일 보기 프로젝트 열기: aura-project/aura

공개 메소드들

메소드 설명
AddActivationSpan ( ActivationSpan span ) : void

Adds the given activation span to the event, in which it's supposed to be active.

AfterLoad ( ) : void

Called after script was registered, so it can schedule itself.

Dispose ( ) : void
End ( ) : void

Stops event if it's active.

Init ( ) : bool

Loads and sets up event.

IsActiveTime ( System.DateTime time ) : bool

Returns true if the event is supposed to be active at the given time, based on its activation spans.

SetId ( string id ) : void

Sets event's id.

SetName ( string name ) : void

Sets event's name, which is used for notices and broadcasts.

Start ( ) : void

Starts event if it's not active yet.

보호된 메소드들

메소드 설명
AddEventItemToShop ( string shopName, int itemId, int amount = 1, int price = -1, int stock = -1 ) : void

Adds the the item to the given shop.

AddFishingGround ( int priority, double chance, IEnumerable locations, IEnumerable items, int rod, int bait ) : void

Adds fishing ground, to be considered when players fish.

The fishing grounds describe where a player can fish under which circumstances, and what they can catch. If multiple fishing grounds exist for a location, the priority and the chance determine which ground is used. For example, if you want to override the Tir fishing spots during and event, you could do the following, which would add a new ground for the Tir spots, with a high priority and a 100% chance, so it always gets selected over the default.

AddGlobalBonus ( GlobalBonusStat stat, float multiplier ) : void

Adds global bonus.

AddGlobalDrop ( GlobalDropType type, DropData data ) : void

Adds global drop by type.

AddGlobalDrop ( int raceId, DropData data ) : void

Adds global drop by race id.

AddGlobalDrop ( string tag, DropData data ) : void

Adds global drop by race tag.

OnEnd ( ) : void

Called when the event is deactivated.

OnStart ( ) : void

Called when the event is activated.

RemoveEventItemsFromShop ( string shopName ) : void

Removes all event items from the given shop.

RemoveFishingGrounds ( ) : void

Removes all event fishing grounds associated with this event.

RemoveGlobalBonuses ( ) : void

Removes all global bonuses associated with this event.

RemoveGlobalDrops ( ) : void

Removes all global drops associated with this event.

ScheduleEvent ( System.DateTime from, System.DateTime till ) : void

Schedules this event to be active during the given time span.

ScheduleEvent ( System.DateTime from, System.TimeSpan timeSpan ) : void

Schedules this event to be active during the given time span.

메소드 상세

AddActivationSpan() 공개 메소드

Adds the given activation span to the event, in which it's supposed to be active.
public AddActivationSpan ( ActivationSpan span ) : void
span ActivationSpan
리턴 void

AddEventItemToShop() 보호된 메소드

Adds the the item to the given shop.
protected AddEventItemToShop ( string shopName, int itemId, int amount = 1, int price = -1, int stock = -1 ) : void
shopName string
itemId int
amount int
price int
stock int
리턴 void

AddFishingGround() 보호된 메소드

Adds fishing ground, to be considered when players fish.
The fishing grounds describe where a player can fish under which circumstances, and what they can catch. If multiple fishing grounds exist for a location, the priority and the chance determine which ground is used. For example, if you want to override the Tir fishing spots during and event, you could do the following, which would add a new ground for the Tir spots, with a high priority and a 100% chance, so it always gets selected over the default.
protected AddFishingGround ( int priority, double chance, IEnumerable locations, IEnumerable items, int rod, int bait ) : void
priority int
chance double
locations IEnumerable
items IEnumerable
rod int
bait int
리턴 void

AddGlobalBonus() 보호된 메소드

Adds global bonus.
protected AddGlobalBonus ( GlobalBonusStat stat, float multiplier ) : void
stat GlobalBonusStat
multiplier float
리턴 void

AddGlobalDrop() 보호된 메소드

Adds global drop by type.
protected AddGlobalDrop ( GlobalDropType type, DropData data ) : void
type GlobalDropType
data DropData
리턴 void

AddGlobalDrop() 보호된 메소드

Adds global drop by race id.
protected AddGlobalDrop ( int raceId, DropData data ) : void
raceId int
data DropData
리턴 void

AddGlobalDrop() 보호된 메소드

Adds global drop by race tag.
protected AddGlobalDrop ( string tag, DropData data ) : void
tag string
data DropData
리턴 void

AfterLoad() 공개 메소드

Called after script was registered, so it can schedule itself.
public AfterLoad ( ) : void
리턴 void

Dispose() 공개 메소드

public Dispose ( ) : void
리턴 void

End() 공개 메소드

Stops event if it's active.
public End ( ) : void
리턴 void

Init() 공개 메소드

Loads and sets up event.
public Init ( ) : bool
리턴 bool

IsActiveTime() 공개 메소드

Returns true if the event is supposed to be active at the given time, based on its activation spans.
public IsActiveTime ( System.DateTime time ) : bool
time System.DateTime
리턴 bool

OnEnd() 보호된 메소드

Called when the event is deactivated.
protected OnEnd ( ) : void
리턴 void

OnStart() 보호된 메소드

Called when the event is activated.
protected OnStart ( ) : void
리턴 void

RemoveEventItemsFromShop() 보호된 메소드

Removes all event items from the given shop.
protected RemoveEventItemsFromShop ( string shopName ) : void
shopName string
리턴 void

RemoveFishingGrounds() 보호된 메소드

Removes all event fishing grounds associated with this event.
protected RemoveFishingGrounds ( ) : void
리턴 void

RemoveGlobalBonuses() 보호된 메소드

Removes all global bonuses associated with this event.
protected RemoveGlobalBonuses ( ) : void
리턴 void

RemoveGlobalDrops() 보호된 메소드

Removes all global drops associated with this event.
protected RemoveGlobalDrops ( ) : void
리턴 void

ScheduleEvent() 보호된 메소드

Schedules this event to be active during the given time span.
protected ScheduleEvent ( System.DateTime from, System.DateTime till ) : void
from System.DateTime
till System.DateTime
리턴 void

ScheduleEvent() 보호된 메소드

Schedules this event to be active during the given time span.
protected ScheduleEvent ( System.DateTime from, System.TimeSpan timeSpan ) : void
from System.DateTime
timeSpan System.TimeSpan
리턴 void

SetId() 공개 메소드

Sets event's id.
public SetId ( string id ) : void
id string
리턴 void

SetName() 공개 메소드

Sets event's name, which is used for notices and broadcasts.
public SetName ( string name ) : void
name string
리턴 void

Start() 공개 메소드

Starts event if it's not active yet.
public Start ( ) : void
리턴 void