Files
RAGECOOP-V/Client/Scripts/Scripting/ClientScript.cs

39 lines
1.4 KiB
C#
Raw Normal View History

2022-07-01 12:22:31 +08:00
using RageCoop.Core.Scripting;
2022-10-10 16:45:58 +08:00
using System;
2022-07-01 12:22:31 +08:00
namespace RageCoop.Client.Scripting
{
2022-05-31 19:35:01 -08:00
/// <summary>
/// Inherit from this class, constructor will be called automatically, but other scripts might have yet been loaded, you should use <see cref="OnStart"/>. to initiate your script.
2022-05-31 19:35:01 -08:00
/// </summary>
2022-10-09 22:07:52 +08:00
public abstract class ClientScript : GTA.Script
{
2022-10-09 22:07:52 +08:00
/// <summary>
/// This method would be called from main thread, right after all script constructors are invoked.
/// </summary>
2022-07-01 12:22:31 +08:00
public abstract void OnStart();
/// <summary>
2022-10-09 23:35:30 +08:00
/// This method would be called from main thread right before the whole <see cref="System.AppDomain"/> is unloded but prior to <see cref="GTA.Script.Aborted"/>.
/// </summary>
2022-07-01 12:22:31 +08:00
public abstract void OnStop();
/// <summary>
/// Get the <see cref="ResourceFile"/> instance where this script is loaded from.
/// </summary>
public ResourceFile CurrentFile { get; internal set; }
2022-07-02 11:23:12 +08:00
/// <summary>
/// Get the <see cref="ClientResource"/> that this script belongs to.
/// </summary>
public ClientResource CurrentResource { get; internal set; }
/// <summary>
/// Eqivalent of <see cref="ClientResource.Logger"/> in <see cref="CurrentResource"/>
/// </summary>
2022-09-06 21:46:35 +08:00
public Core.Logger Logger => CurrentResource.Logger;
}
}