diff --git a/docs/api/RageCoop.Client.Scripting.API.html b/docs/api/RageCoop.Client.Scripting.API.html index e516b33..b0ef833 100644 --- a/docs/api/RageCoop.Client.Scripting.API.html +++ b/docs/api/RageCoop.Client.Scripting.API.html @@ -447,8 +447,7 @@ List<Object> args -

The objects conataing your data, supported types: -byte, short, ushort, int, uint, long, ulong, float, bool, string.

+

The objects conataing your data, see CustomEventReceivedArgs for a list of supported types

diff --git a/docs/api/RageCoop.Client.Scripting.ClientScript.html b/docs/api/RageCoop.Client.Scripting.ClientScript.html index eee9a02..58c0994 100644 --- a/docs/api/RageCoop.Client.Scripting.ClientScript.html +++ b/docs/api/RageCoop.Client.Scripting.ClientScript.html @@ -181,7 +181,7 @@

OnStart()

-

This method would be called from main thread shortly after all scripts have been loaded.

+

This method would be called from background thread, call QueueAction(Action) to dispatch it to main thread.

Declaration
@@ -192,7 +192,7 @@

OnStop()

-

This method would be called from main thread when the client disconnected from the server, you MUST terminate all background jobs/threads in this method.

+

This method would be called from background thread when the client disconnected from the server, you MUST terminate all background jobs/threads in this method.

Declaration
diff --git a/docs/api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html b/docs/api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html index c07a968..bd4d0e1 100644 --- a/docs/api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html +++ b/docs/api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html @@ -130,7 +130,7 @@

Args

-

Arguments

+

Supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string, Vector3, Quaternion

Declaration
diff --git a/docs/api/RageCoop.Server.Scripting.API.html b/docs/api/RageCoop.Server.Scripting.API.html index 8b79ad0..a89ec4f 100644 --- a/docs/api/RageCoop.Server.Scripting.API.html +++ b/docs/api/RageCoop.Server.Scripting.API.html @@ -306,7 +306,7 @@ Action<CommandContext> callback -

Create a new function!

+

A callback to invoke when the command received.

@@ -353,7 +353,7 @@ Action<CommandContext> callback -

Create a new function!

+

A callback to invoke when the command received.

@@ -444,7 +444,7 @@ Action<CustomEventReceivedArgs> handler -

An handler to be invoked when the event is received from the server. This will be invoked from main thread.

+

An handler to be invoked when the event is received from the server.

@@ -555,7 +555,7 @@ List<Object> args -

The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string.

+

The objects conataing your data, see Args for supported types.

@@ -596,7 +596,7 @@ List<Object> args -

The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string.

+

See CustomEventReceivedArgs for a list of supported types.

diff --git a/docs/api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html b/docs/api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html index 7fbc068..a5b7846 100644 --- a/docs/api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html +++ b/docs/api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html @@ -130,7 +130,7 @@

Args

-

The arguments of this event

+

Supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string, Vector3, Quaternion, ServerPed, ServerVehicle, ServerProp

Declaration
diff --git a/docs/api/RageCoop.Server.ServerPed.html b/docs/api/RageCoop.Server.ServerPed.html index ff5e486..8118bff 100644 --- a/docs/api/RageCoop.Server.ServerPed.html +++ b/docs/api/RageCoop.Server.ServerPed.html @@ -127,7 +127,7 @@

Handle

-

Pass the value as an argument in SendCustomEvent(Int32, List<Object>, List<Client>) or SendCustomEvent(Int32, Object[]) to convert this object to handle at client side.

+

Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side.

Declaration
diff --git a/docs/api/RageCoop.Server.ServerProp.html b/docs/api/RageCoop.Server.ServerProp.html index f0a8b9c..c08f233 100644 --- a/docs/api/RageCoop.Server.ServerProp.html +++ b/docs/api/RageCoop.Server.ServerProp.html @@ -127,7 +127,7 @@

Handle

-

Pass the value as an argument in SendCustomEvent(Int32, List<Object>, List<Client>) or SendCustomEvent(Int32, Object[]) to convert this object to handle at client side.

+

Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side.

Declaration
diff --git a/docs/api/RageCoop.Server.ServerVehicle.html b/docs/api/RageCoop.Server.ServerVehicle.html index a2e96cf..8281bbe 100644 --- a/docs/api/RageCoop.Server.ServerVehicle.html +++ b/docs/api/RageCoop.Server.ServerVehicle.html @@ -127,7 +127,7 @@

Handle

-

Pass the value as an argument in SendCustomEvent(Int32, List<Object>, List<Client>) or SendCustomEvent(Int32, Object[]) to convert this object to handle at client side.

+

Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side.

Declaration
diff --git a/docs/index.json b/docs/index.json index be9d5d6..30ed3ba 100644 --- a/docs/index.json +++ b/docs/index.json @@ -37,7 +37,7 @@ "api/RageCoop.Client.Scripting.API.html": { "href": "api/RageCoop.Client.Scripting.API.html", "title": "Class API | RageCoop resource documentation", - "keywords": "Class API Provides vital functionality to interact with RAGECOOP Inheritance Object API Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : RageCoop.Client.Scripting Assembly : RageCoop.Client.dll Syntax public static class API Properties CurrentVersion Get the version of RAGECOOP Declaration public static string CurrentVersion { get; } Property Value Type Description String IsChatFocused Check if the RAGECOOP chat is visible Declaration public static bool IsChatFocused { get; } Property Value Type Description Boolean IsMenuVisible Check if a RAGECOOP menu is visible Declaration public static bool IsMenuVisible { get; } Property Value Type Description Boolean IsOnServer Check if the player is already on a server Declaration public static bool IsOnServer { get; } Property Value Type Description Boolean IsPlayerListVisible Check if the RAGECOOP list of players is visible Declaration public static bool IsPlayerListVisible { get; } Property Value Type Description Boolean LocalPlayerID Get the local player's ID Declaration public static int LocalPlayerID { get; } Property Value Type Description Int32 PlayerID Logger Get a Logger that RAGECOOP is currently using. Declaration public static Logger Logger { get; } Property Value Type Description Logger Methods Disconnect() Disconnect from the server Declaration public static void Disconnect() LocalChatMessage(String, String) Send a local chat message to this player Declaration public static void LocalChatMessage(string from, string message) Parameters Type Name Description String from Name of the sender String message The player's message QueueAction(Action) Queue an action to be executed on next tick. Declaration public static void QueueAction(Action a) Parameters Type Name Description Action a RegisterCustomEventHandler(Int32, Action) Register an handler to the specifed event hash, one event can have multiple handlers. This will be invoked from backgound thread, use QueueAction(Action) in the handler to dispatch code to script thread. Declaration public static void RegisterCustomEventHandler(int hash, Action handler) Parameters Type Name Description Int32 hash An unique identifier of the event, you can hash your event name with Hash(String) Action < CustomEventReceivedArgs > handler An handler to be invoked when the event is received from the server. SendCustomEvent(Int32, List) Send an event and data to the server. Declaration public static void SendCustomEvent(int eventHash, List args) Parameters Type Name Description Int32 eventHash An unique identifier of the event List < Object > args The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string. SendCustomEvent(Int32, Object[]) Send an event and data to the server. Declaration public static void SendCustomEvent(int eventHash, params object[] args) Parameters Type Name Description Int32 eventHash Object [] args" + "keywords": "Class API Provides vital functionality to interact with RAGECOOP Inheritance Object API Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : RageCoop.Client.Scripting Assembly : RageCoop.Client.dll Syntax public static class API Properties CurrentVersion Get the version of RAGECOOP Declaration public static string CurrentVersion { get; } Property Value Type Description String IsChatFocused Check if the RAGECOOP chat is visible Declaration public static bool IsChatFocused { get; } Property Value Type Description Boolean IsMenuVisible Check if a RAGECOOP menu is visible Declaration public static bool IsMenuVisible { get; } Property Value Type Description Boolean IsOnServer Check if the player is already on a server Declaration public static bool IsOnServer { get; } Property Value Type Description Boolean IsPlayerListVisible Check if the RAGECOOP list of players is visible Declaration public static bool IsPlayerListVisible { get; } Property Value Type Description Boolean LocalPlayerID Get the local player's ID Declaration public static int LocalPlayerID { get; } Property Value Type Description Int32 PlayerID Logger Get a Logger that RAGECOOP is currently using. Declaration public static Logger Logger { get; } Property Value Type Description Logger Methods Disconnect() Disconnect from the server Declaration public static void Disconnect() LocalChatMessage(String, String) Send a local chat message to this player Declaration public static void LocalChatMessage(string from, string message) Parameters Type Name Description String from Name of the sender String message The player's message QueueAction(Action) Queue an action to be executed on next tick. Declaration public static void QueueAction(Action a) Parameters Type Name Description Action a RegisterCustomEventHandler(Int32, Action) Register an handler to the specifed event hash, one event can have multiple handlers. This will be invoked from backgound thread, use QueueAction(Action) in the handler to dispatch code to script thread. Declaration public static void RegisterCustomEventHandler(int hash, Action handler) Parameters Type Name Description Int32 hash An unique identifier of the event, you can hash your event name with Hash(String) Action < CustomEventReceivedArgs > handler An handler to be invoked when the event is received from the server. SendCustomEvent(Int32, List) Send an event and data to the server. Declaration public static void SendCustomEvent(int eventHash, List args) Parameters Type Name Description Int32 eventHash An unique identifier of the event List < Object > args The objects conataing your data, see CustomEventReceivedArgs for a list of supported types SendCustomEvent(Int32, Object[]) Send an event and data to the server. Declaration public static void SendCustomEvent(int eventHash, params object[] args) Parameters Type Name Description Int32 eventHash Object [] args" }, "api/RageCoop.Client.Scripting.ClientResource.html": { "href": "api/RageCoop.Client.Scripting.ClientResource.html", @@ -47,12 +47,12 @@ "api/RageCoop.Client.Scripting.ClientScript.html": { "href": "api/RageCoop.Client.Scripting.ClientScript.html", "title": "Class ClientScript | RageCoop resource documentation", - "keywords": "Class ClientScript Inherit from this class, constructor will be called automatically, but other scripts might have yet been loaded, you should use OnStart() . to initiate your script. Inheritance Object ClientScript Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : RageCoop.Client.Scripting Assembly : RageCoop.Client.dll Syntax public abstract class ClientScript Properties CurrentFile Get the ResourceFile instance where this script is loaded from. Declaration public ResourceFile CurrentFile { get; } Property Value Type Description ResourceFile CurrentResource Get the ClientResource that this script belongs to. Declaration public ClientResource CurrentResource { get; } Property Value Type Description ClientResource Methods OnStart() This method would be called from main thread shortly after all scripts have been loaded. Declaration public abstract void OnStart() OnStop() This method would be called from main thread when the client disconnected from the server, you MUST terminate all background jobs/threads in this method. Declaration public abstract void OnStop()" + "keywords": "Class ClientScript Inherit from this class, constructor will be called automatically, but other scripts might have yet been loaded, you should use OnStart() . to initiate your script. Inheritance Object ClientScript Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : RageCoop.Client.Scripting Assembly : RageCoop.Client.dll Syntax public abstract class ClientScript Properties CurrentFile Get the ResourceFile instance where this script is loaded from. Declaration public ResourceFile CurrentFile { get; } Property Value Type Description ResourceFile CurrentResource Get the ClientResource that this script belongs to. Declaration public ClientResource CurrentResource { get; } Property Value Type Description ClientResource Methods OnStart() This method would be called from background thread, call QueueAction(Action) to dispatch it to main thread. Declaration public abstract void OnStart() OnStop() This method would be called from background thread when the client disconnected from the server, you MUST terminate all background jobs/threads in this method. Declaration public abstract void OnStop()" }, "api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html": { "href": "api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html", "title": "Class CustomEventReceivedArgs | RageCoop resource documentation", - "keywords": "Class CustomEventReceivedArgs Inheritance Object EventArgs CustomEventReceivedArgs Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : RageCoop.Client.Scripting Assembly : RageCoop.Client.dll Syntax public class CustomEventReceivedArgs : EventArgs Properties Args Arguments Declaration public List Args { get; set; } Property Value Type Description List < Object > Hash The event hash Declaration public int Hash { get; set; } Property Value Type Description Int32" + "keywords": "Class CustomEventReceivedArgs Inheritance Object EventArgs CustomEventReceivedArgs Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : RageCoop.Client.Scripting Assembly : RageCoop.Client.dll Syntax public class CustomEventReceivedArgs : EventArgs Properties Args Supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string, Vector3, Quaternion Declaration public List Args { get; set; } Property Value Type Description List < Object > Hash The event hash Declaration public int Hash { get; set; } Property Value Type Description Int32" }, "api/RageCoop.Client.Scripting.html": { "href": "api/RageCoop.Client.Scripting.html", @@ -137,7 +137,7 @@ "api/RageCoop.Server.Scripting.API.html": { "href": "api/RageCoop.Server.Scripting.API.html", "title": "Class API | RageCoop resource documentation", - "keywords": "Class API An class that can be used to interact with RageCoop server. Inheritance Object API Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server.Scripting Assembly : RageCoop.Server.dll Syntax public class API Fields Events Server side events Declaration public readonly ServerEvents Events Field Value Type Description ServerEvents Properties Entities All synchronized entities on this server. Declaration public ServerEntities Entities { get; } Property Value Type Description ServerEntities Logger Get a Logger that the server is currently using, you should use Logger to display resource-specific information. Declaration public Logger Logger { get; } Property Value Type Description Logger Methods GetAllClients() Get a list of all Clients Declaration public Dictionary GetAllClients() Returns Type Description Dictionary < Int64 , Client > All clients as a dictionary indexed by NetID GetClientByUsername(String) Get the client by its username Declaration public Client GetClientByUsername(string username) Parameters Type Name Description String username The username to search for (non case-sensitive) Returns Type Description Client The Client from this user or null RegisterCommand(String, Action) Register a new command chat command (Example: \"/test\") Declaration public void RegisterCommand(string name, Action callback) Parameters Type Name Description String name The name of the command (Example: \"test\" for \"/test\") Action < CommandContext > callback Create a new function! RegisterCommand(String, String, Int16, Action) Send CleanUpWorld to all players to delete all objects created by the server Declaration public void RegisterCommand(string name, string usage, short argsLength, Action callback) Parameters Type Name Description String name The name of the command (Example: \"test\" for \"/test\") String usage How to use this message (argsLength required!) Int16 argsLength The length of args (Example: \"/message USERNAME MESSAGE\" = 2) (usage required!) Action < CommandContext > callback Create a new function! RegisterCommands(Object) Register all commands inside an class instance Declaration public void RegisterCommands(object obj) Parameters Type Name Description Object obj The instance of type containing the commands RegisterCommands() Register all commands in a static class Declaration public void RegisterCommands() Type Parameters Name Description T Your static class with commands RegisterCustomEventHandler(Int32, Action) Register an handler to the specifed event hash, one event can have multiple handlers. Declaration public void RegisterCustomEventHandler(int hash, Action handler) Parameters Type Name Description Int32 hash An unique identifier of the event, you can hash your event name with Hash(String) Action < CustomEventReceivedArgs > handler An handler to be invoked when the event is received from the server. This will be invoked from main thread. RegisterCustomEventHandler(String, Action) Register an event handler for specified event name. Declaration public void RegisterCustomEventHandler(string name, Action handler) Parameters Type Name Description String name This value will be hashed to an int to reduce overhead Action < CustomEventReceivedArgs > handler The handler to be invoked when the event is received SendChatMessage(String, List, String) Send a chat message to all players, use SendChatMessage(String, String) to send to an individual client. Declaration public void SendChatMessage(string message, List targets = null, string username = \"Server\") Parameters Type Name Description String message The chat message List < Client > targets The clients to send message, leave it null to send to all clients String username The username which send this message (default = \"Server\") SendCustomEvent(Int32, List, List) Send an event and data to the specified clients. Use SendCustomEvent(Int32, List) if you want to send event to individual client. Declaration public void SendCustomEvent(int eventHash, List args = null, List targets = null) Parameters Type Name Description Int32 eventHash An unique identifier of the event, you can use Hash(String) to get it from a string List < Object > args The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string. List < Client > targets The target clients to send. Leave it null to send to all clients SendCustomEvent(String, List, List) Send an event and data to the specified clients. Use SendCustomEvent(Int32, List) if you want to send event to individual client. Declaration public void SendCustomEvent(string name, List args = null, List targets = null) Parameters Type Name Description String name The name of the event, will be hashed to an int. For optimal performence, you should hash it in a static contructor inside the shared library, then call SendCustomEvent(Int32, List, List) . List < Object > args The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string. List < Client > targets The target clients to send. Leave it null to send to all clients" + "keywords": "Class API An class that can be used to interact with RageCoop server. Inheritance Object API Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server.Scripting Assembly : RageCoop.Server.dll Syntax public class API Fields Events Server side events Declaration public readonly ServerEvents Events Field Value Type Description ServerEvents Properties Entities All synchronized entities on this server. Declaration public ServerEntities Entities { get; } Property Value Type Description ServerEntities Logger Get a Logger that the server is currently using, you should use Logger to display resource-specific information. Declaration public Logger Logger { get; } Property Value Type Description Logger Methods GetAllClients() Get a list of all Clients Declaration public Dictionary GetAllClients() Returns Type Description Dictionary < Int64 , Client > All clients as a dictionary indexed by NetID GetClientByUsername(String) Get the client by its username Declaration public Client GetClientByUsername(string username) Parameters Type Name Description String username The username to search for (non case-sensitive) Returns Type Description Client The Client from this user or null RegisterCommand(String, Action) Register a new command chat command (Example: \"/test\") Declaration public void RegisterCommand(string name, Action callback) Parameters Type Name Description String name The name of the command (Example: \"test\" for \"/test\") Action < CommandContext > callback A callback to invoke when the command received. RegisterCommand(String, String, Int16, Action) Send CleanUpWorld to all players to delete all objects created by the server Declaration public void RegisterCommand(string name, string usage, short argsLength, Action callback) Parameters Type Name Description String name The name of the command (Example: \"test\" for \"/test\") String usage How to use this message (argsLength required!) Int16 argsLength The length of args (Example: \"/message USERNAME MESSAGE\" = 2) (usage required!) Action < CommandContext > callback A callback to invoke when the command received. RegisterCommands(Object) Register all commands inside an class instance Declaration public void RegisterCommands(object obj) Parameters Type Name Description Object obj The instance of type containing the commands RegisterCommands() Register all commands in a static class Declaration public void RegisterCommands() Type Parameters Name Description T Your static class with commands RegisterCustomEventHandler(Int32, Action) Register an handler to the specifed event hash, one event can have multiple handlers. Declaration public void RegisterCustomEventHandler(int hash, Action handler) Parameters Type Name Description Int32 hash An unique identifier of the event, you can hash your event name with Hash(String) Action < CustomEventReceivedArgs > handler An handler to be invoked when the event is received from the server. RegisterCustomEventHandler(String, Action) Register an event handler for specified event name. Declaration public void RegisterCustomEventHandler(string name, Action handler) Parameters Type Name Description String name This value will be hashed to an int to reduce overhead Action < CustomEventReceivedArgs > handler The handler to be invoked when the event is received SendChatMessage(String, List, String) Send a chat message to all players, use SendChatMessage(String, String) to send to an individual client. Declaration public void SendChatMessage(string message, List targets = null, string username = \"Server\") Parameters Type Name Description String message The chat message List < Client > targets The clients to send message, leave it null to send to all clients String username The username which send this message (default = \"Server\") SendCustomEvent(Int32, List, List) Send an event and data to the specified clients. Use SendCustomEvent(Int32, List) if you want to send event to individual client. Declaration public void SendCustomEvent(int eventHash, List args = null, List targets = null) Parameters Type Name Description Int32 eventHash An unique identifier of the event, you can use Hash(String) to get it from a string List < Object > args The objects conataing your data, see Args for supported types. List < Client > targets The target clients to send. Leave it null to send to all clients SendCustomEvent(String, List, List) Send an event and data to the specified clients. Use SendCustomEvent(Int32, List) if you want to send event to individual client. Declaration public void SendCustomEvent(string name, List args = null, List targets = null) Parameters Type Name Description String name The name of the event, will be hashed to an int. For optimal performence, you should hash it in a static contructor inside the shared library, then call SendCustomEvent(Int32, List, List) . List < Object > args See CustomEventReceivedArgs for a list of supported types. List < Client > targets The target clients to send. Leave it null to send to all clients" }, "api/RageCoop.Server.Scripting.ChatEventArgs.html": { "href": "api/RageCoop.Server.Scripting.ChatEventArgs.html", @@ -157,7 +157,7 @@ "api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html": { "href": "api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html", "title": "Class CustomEventReceivedArgs | RageCoop resource documentation", - "keywords": "Class CustomEventReceivedArgs Inheritance Object EventArgs CustomEventReceivedArgs Inherited Members EventArgs.Empty Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server.Scripting Assembly : RageCoop.Server.dll Syntax public class CustomEventReceivedArgs : EventArgs Properties Args The arguments of this event Declaration public List Args { get; set; } Property Value Type Description List < Object > Hash The event hash Declaration public int Hash { get; set; } Property Value Type Description Int32 Sender The Client that triggered this event Declaration public Client Sender { get; set; } Property Value Type Description Client" + "keywords": "Class CustomEventReceivedArgs Inheritance Object EventArgs CustomEventReceivedArgs Inherited Members EventArgs.Empty Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server.Scripting Assembly : RageCoop.Server.dll Syntax public class CustomEventReceivedArgs : EventArgs Properties Args Supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string, Vector3, Quaternion, ServerPed, ServerVehicle, ServerProp Declaration public List Args { get; set; } Property Value Type Description List < Object > Hash The event hash Declaration public int Hash { get; set; } Property Value Type Description Int32 Sender The Client that triggered this event Declaration public Client Sender { get; set; } Property Value Type Description Client" }, "api/RageCoop.Server.Scripting.HandshakeEventArgs.html": { "href": "api/RageCoop.Server.Scripting.HandshakeEventArgs.html", @@ -202,12 +202,12 @@ "api/RageCoop.Server.ServerPed.html": { "href": "api/RageCoop.Server.ServerPed.html", "title": "Class ServerPed | RageCoop resource documentation", - "keywords": "Class ServerPed Represents a ped from a client Inheritance Object ServerPed Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server Assembly : RageCoop.Server.dll Syntax public class ServerPed Properties Handle Pass the value as an argument in SendCustomEvent(Int32, List, List) or SendCustomEvent(Int32, Object[]) to convert this object to handle at client side. Declaration public Tuple Handle { get; } Property Value Type Description Tuple < Byte , Byte []> Health Health Declaration public int Health { get; } Property Value Type Description Int32 ID The ped's network ID (not handle!). Declaration public int ID { get; } Property Value Type Description Int32 IsPlayer Whether this ped is a player. Declaration public bool IsPlayer { get; } Property Value Type Description Boolean LastVehicle The ped's last vehicle. Declaration public ServerVehicle LastVehicle { get; } Property Value Type Description ServerVehicle Owner The Client that is responsible synchronizing for this ped. Declaration public Client Owner { get; } Property Value Type Description Client Position Position of this ped Declaration public Vector3 Position { get; } Property Value Type Description GTA.Math.Vector3 Rotation Gets or sets this ped's rotation Declaration public Vector3 Rotation { get; } Property Value Type Description GTA.Math.Vector3" + "keywords": "Class ServerPed Represents a ped from a client Inheritance Object ServerPed Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server Assembly : RageCoop.Server.dll Syntax public class ServerPed Properties Handle Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side. Declaration public Tuple Handle { get; } Property Value Type Description Tuple < Byte , Byte []> Health Health Declaration public int Health { get; } Property Value Type Description Int32 ID The ped's network ID (not handle!). Declaration public int ID { get; } Property Value Type Description Int32 IsPlayer Whether this ped is a player. Declaration public bool IsPlayer { get; } Property Value Type Description Boolean LastVehicle The ped's last vehicle. Declaration public ServerVehicle LastVehicle { get; } Property Value Type Description ServerVehicle Owner The Client that is responsible synchronizing for this ped. Declaration public Client Owner { get; } Property Value Type Description Client Position Position of this ped Declaration public Vector3 Position { get; } Property Value Type Description GTA.Math.Vector3 Rotation Gets or sets this ped's rotation Declaration public Vector3 Rotation { get; } Property Value Type Description GTA.Math.Vector3" }, "api/RageCoop.Server.ServerProp.html": { "href": "api/RageCoop.Server.ServerProp.html", "title": "Class ServerProp | RageCoop resource documentation", - "keywords": "Class ServerProp Represents an prop owned by server. Inheritance Object ServerProp Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server Assembly : RageCoop.Server.dll Syntax public class ServerProp Properties Handle Pass the value as an argument in SendCustomEvent(Int32, List, List) or SendCustomEvent(Int32, Object[]) to convert this object to handle at client side. Declaration public Tuple Handle { get; } Property Value Type Description Tuple < Byte , Byte []> ID Network ID of this object. Declaration public int ID { get; } Property Value Type Description Int32 Model The object's model Declaration public Model Model { get; } Property Value Type Description GTA.Model Position Gets or sets this object's position Declaration public Vector3 Position { get; set; } Property Value Type Description GTA.Math.Vector3 Rotation Gets or sets this object's rotation Declaration public Vector3 Rotation { get; set; } Property Value Type Description GTA.Math.Vector3 Methods Delete() Delete this prop Declaration public void Delete()" + "keywords": "Class ServerProp Represents an prop owned by server. Inheritance Object ServerProp Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server Assembly : RageCoop.Server.dll Syntax public class ServerProp Properties Handle Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side. Declaration public Tuple Handle { get; } Property Value Type Description Tuple < Byte , Byte []> ID Network ID of this object. Declaration public int ID { get; } Property Value Type Description Int32 Model The object's model Declaration public Model Model { get; } Property Value Type Description GTA.Model Position Gets or sets this object's position Declaration public Vector3 Position { get; set; } Property Value Type Description GTA.Math.Vector3 Rotation Gets or sets this object's rotation Declaration public Vector3 Rotation { get; set; } Property Value Type Description GTA.Math.Vector3 Methods Delete() Delete this prop Declaration public void Delete()" }, "api/RageCoop.Server.ServerSettings.html": { "href": "api/RageCoop.Server.ServerSettings.html", @@ -217,7 +217,7 @@ "api/RageCoop.Server.ServerVehicle.html": { "href": "api/RageCoop.Server.ServerVehicle.html", "title": "Class ServerVehicle | RageCoop resource documentation", - "keywords": "Class ServerVehicle Represents a vehicle from a client Inheritance Object ServerVehicle Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server Assembly : RageCoop.Server.dll Syntax public class ServerVehicle Properties Handle Pass the value as an argument in SendCustomEvent(Int32, List, List) or SendCustomEvent(Int32, Object[]) to convert this object to handle at client side. Declaration public Tuple Handle { get; } Property Value Type Description Tuple < Byte , Byte []> ID The vehicle's network ID (not handle!). Declaration public int ID { get; } Property Value Type Description Int32 Owner The Client that is responsible synchronizing for this vehicle. Declaration public Client Owner { get; } Property Value Type Description Client Position Position of this vehicle Declaration public Vector3 Position { get; } Property Value Type Description GTA.Math.Vector3 Quaternion Gets or sets this vehicle's quaternion Declaration public Quaternion Quaternion { get; } Property Value Type Description GTA.Math.Quaternion" + "keywords": "Class ServerVehicle Represents a vehicle from a client Inheritance Object ServerVehicle Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Object.ToString() Namespace : RageCoop.Server Assembly : RageCoop.Server.dll Syntax public class ServerVehicle Properties Handle Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side. Declaration public Tuple Handle { get; } Property Value Type Description Tuple < Byte , Byte []> ID The vehicle's network ID (not handle!). Declaration public int ID { get; } Property Value Type Description Int32 Owner The Client that is responsible synchronizing for this vehicle. Declaration public Client Owner { get; } Property Value Type Description Client Position Position of this vehicle Declaration public Vector3 Position { get; } Property Value Type Description GTA.Math.Vector3 Quaternion Gets or sets this vehicle's quaternion Declaration public Quaternion Quaternion { get; } Property Value Type Description GTA.Math.Quaternion" }, "index.html": { "href": "index.html", diff --git a/docs/manifest.json b/docs/manifest.json index fab54ce..a0ba869 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -117,7 +117,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Client.Scripting.API.html", - "hash": "Ia+Sh3EBdepmbfJ+BGpzSBf6eKuA/n+d3gtuuWbWeFA=" + "hash": "qXU3gGLs3KnRlOWHnO08E985GHx+ixSrrbB7NGAyBfM=" } }, "is_incremental": false, @@ -141,7 +141,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Client.Scripting.ClientScript.html", - "hash": "N73yvdl0ubXKOzOi/yGMNG8u9t/xqzSSN4Jpkk81agE=" + "hash": "V8Yh0W8zbx3z/YXULlTmYhfrDWZvlxPkwLOCikAP7pc=" } }, "is_incremental": false, @@ -153,7 +153,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html", - "hash": "gPKV+5Ur/yanNA6H9nMpkM4POo4/XU1gjrJCY77p6dA=" + "hash": "/oQtDZe9+7w9CKt/AnXoqrDu/1D6OVDLGkNXJLDr+u8=" } }, "is_incremental": false, @@ -357,7 +357,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Server.Scripting.API.html", - "hash": "VDClnRrNQDeUyHDlLMKHr1LRqviN0OCHiKxmJuc8fkc=" + "hash": "8ybDlQGQCl50xj9srw155Cyj35PK9UuX0RpEQlTFkbQ=" } }, "is_incremental": false, @@ -405,7 +405,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html", - "hash": "QL/7GcZ2eBogliH8UHmn3X9BytvNlqUqAwd0qylIUCI=" + "hash": "NdiRA5BPjg6z2Ry5ZEBnOg9mKqXVd1imw27AV1CdHs8=" } }, "is_incremental": false, @@ -513,7 +513,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Server.ServerPed.html", - "hash": "PQCf8t9TCPc1tEWai7OQxm98cwLHNa9Zl654KG0Gu4c=" + "hash": "QpNMMs/mGAlwPIh8YdZxF4UDgqO2Ob9gPdlc/7mNNII=" } }, "is_incremental": false, @@ -525,7 +525,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Server.ServerProp.html", - "hash": "0UJO4Oyjocb1AmzGFELQ9EjrW+F1iPH5o5xFlX7cJpU=" + "hash": "NH1CyF2tlK2ab69oAYGph5TlzRIWB1f7jLZJn4/juU4=" } }, "is_incremental": false, @@ -549,7 +549,7 @@ "output": { ".html": { "relative_path": "api/RageCoop.Server.ServerVehicle.html", - "hash": "bySWfd4MWrMOM5QEncfd3fCCOieNPpIbLoXiGsKWtp8=" + "hash": "097s7xTmGbr3wTX4kq9xmE0cMtZbzwkYZbnHv7iUV2o=" } }, "is_incremental": false,