SlEvent

Information

• Type: Class
• Description: The core class of this whole project. Provides way to register events and what to do when they're playing/are stopped.

Properties

Name

• Type: string
• Description: The name of event, used in commands to show admins what events are to what id.

Id

• Type: int
• Description: The Id of the event. VERY IMPORTANT. If any duplicates are found and there will be attempt to register event, it will override event.

IsEnabled

• Type: bool
• Description: Property used to show if event is enabled or not. This is Accessed from methods StartEvent() & EndEvent().

EventRegistry

• Type: System.Collections.Generic.List
• Description: List that will at the end of event unregister everything from the list.
• Additional: This is virtual property.

Coroutines

• Type: System.Collections.Generic.List
• Description: List that will at the end of event stop every loop from the list.
• Additional: This is virtual property.

Delays

• Type: System.Collections.Generic.List
• Description: List that will at the end of event stop every delayed code from the list.
• Additional: This is virtual property.

Handles

• Type: System.Collections.Generic.List
• Description: List that will at the end of event kill every coroutine.
• Additional: This is virtual property.

Methods

Start

• Returns: void
• Arguments: X
• Description: Method designed to be overriden when SlEvent is inherited. Will be executed when event is started.
• Additional: This is virtual method.

End

• Returns: void
• Arguments: X
• Description: Method designed to be overriden when SlEvent is inherited. Will be executed when event is ended.
• Additional: This is virtual method.

RegisterAll

• Returns: void
• Arguments: System.Reflection.Assembly (Optional)
• Description: Method that will look through all types located in assembly. When it will find one inheriting from SlEvnet it will register into dictionary. If you won't specify assembly in arguments it will look through the assembly that called the method (not executed).
• Additional: This is static method.

UnregisterAll

• Returns: void
• Arguments: X
• Description: Method that will clear Instances & end them.
• Additional: This is static method.

Get

• Returns: SlEvent? Nullable value type
• Arguments: int
• Description: After inputting Id, it will return the event by Id. If event not found then it will return Null value.
• Additional: This is static method.

Start

• Returns: bool
• Arguments: int
• Description: Will use Get() method and then StartEvent() by Id.
• Additional: This is static method.

End

• Returns: bool
• Arguments: int
• Description: Will use Get() method and then StopEvent() by Id.
• Additional: This is static method.

StartEvent

• Returns: void
• Arguments: X
• Description: Will stop event playing with same Id if it is started, set IsEnabled = true & virtual method Start.

EndEvent

• Returns: void
• Arguments: X
• Description: Will set IsEnabled = false. Will Unsub from every EventRegistry stop every Coroutines & Delays, kill Handles and clear them.