ParaScript

Description

ParaScript is a user-generated content (UGC) component developed by ParaSpace. It achieves the capabilities similar to the Unity3D MonoBehaviour component, allowing you to create a prefab with logic code.

Property


paraObject	paraObject associated with the object
script	Lua table that stores the variables and functions defined in the associated script
scriptName	Name of the Lua script associated with the object
updateOrder	Order of calling a script

Public method


SendMessageToOwner	Sends messages to the network owner of the component.
SendMessageToAll	Sends messages to all the endpoints including yourself.
SendMessageToTarget	Sends messages to the endpoint where the specified player resides.
OwnerCall	Makes a remote call to the specified function in the object owner’s script.
TargetCall	Makes a remote call to the specified function in the specified player’s script.
RequestOwnership	Requests the network owner permissions of the object.
HasOwnership	Judges if network permissions are granted.
GetParaScript	Gets all the ParaScripts of the component on a GameObject.
GetParaScripts	Gets all the ParaScripts of the component on a GameObject, and returns an array of the same name.
GetOwner	Gets the paraplayer that owns the game object.
SetOwner	Sets the owner of the object. The function works only when the object is owned by yourself.
IsOwner	Judges if the specified ParaPlayer is the owner.
EnableInteraction	Enables interactions. Both 3D and 2D interactions are supported.
DisableInteraction	Disables interactions.
Respawn	Respawns a ParaScript object and sets its position and rotation based on the initial state of the scene.
SendMessageToOthers	Sends network events to other players in a room.

Message


Awake	Awake is called when the script instance is being loaded.
Start	Start is called on the frame when a script is enabled just before any of the Update methods are called the first time.
Update	Update is called every frame, if the MonoBehaviour is enabled.
FixedUpdate	Frame-rate independent MonoBehaviour.FixedUpdate message for physics calculations.
LateUpdate	LateUpdate is called every frame, if the Behaviour is enabled.
OnBeginDrag	Interface to implement if you wish to receive OnBeginDrag callbacks.
OnDisable	This function is called when the behaviour becomes disabled.
OnEnable	This function is called when the object becomes enabled and active.
OnCollisionEnter	OnCollisionEnter is called when this collider/rigidbody has begun touching another rigidbody/collider.
OnCollisionExit	OnCollisionExit is called when this collider/rigidbody has stopped touching another rigidbody/collider.
OnTriggerEnter	When a GameObject collides with another GameObject, Unity calls OnTriggerEnter.
OnTriggerExit	OnTriggerExit is called when the Collider other has stopped touching the trigger.
OnNetSpawned	After the network properties of the object are initialized.
OnOwnershipRequest	If the function is defined in the script, you are notified when you receive an ownership transfer request on the object.
OnOwnershipTransferred	You are notified when the ownership is transferred.
OnUIPointerDown	Triggered when the UI button or joystick is being pressed.
OnUIPointerUp	Triggered when the UI button or joystick is being released.
OnUIPointerClick	Triggered when the UI button or joystick is being clicked.
OnUILongPress	Triggered when the UI button or joystick is being pressed and held.
OnUIDrag	Triggered when the UI joystick is being pressed and dragged.
OnFocus	Gets focus, and becomes the default interaction object.
OnLostFocus	Loses focus.
On3DTouchBegin	Triggered when an object is being pressed on the screen.
On3DTouchDrag	Triggered when an object is being pressed and dragged on the screen.
On3DTouchEnd	Triggered when an object is being released on the screen.
On3DClick	Triggered when an object is being clicked on the screen.
OnInteract	Triggered when a player interacts with the object, on which the basic interaction component needs to be mounted.
OnPlayerDrop	Triggered when the object is dropped by a player.
OnPickup	Triggered when the object is picked up by a player.
OnTheft	Triggered when the object is thieved by a player, or the API is called.
OnRespawn	The object respawns at a height lower than the threshold configured for the World currently.
OnSeatEntered	When a player takes a seat.
OnSeatExited	When a player rises from the seat and exits.
OnPlayerTriggerEnter	Fired when a player's capsule enters a Trigger Collider.
OnPlayerTriggerExit	Fired when a player's capsule exits a Trigger Collider.
OnPlayerCollisionEnter	Fired when a player's capsule enters a Collider.
OnPlayerCollisionExit	Fired when a player's capsule exits a Collider.
OnPlayerJoined	When a player joins the room.
OnPlayerLeft	When a player leaves the room.
OnPlayerRespawn	Fired when a player respawns.
OnDestroy	Fired when the gameObject destroyed
OnCancel	Interface to implement if you wish to receive OnCancel callbacks.
OnDrag	Interface to implement if you wish to receive OnDrag callbacks.
OnDrop	Interface to implement if you wish to receive OnDrop callbacks.
OnEndDrag	Interface to implement if you wish to receive OnEndDrag callbacks.
OnMouseDown	OnMouseDown is called when the user has pressed the mouse button while over the Collider.
OnMouseDrag	OnMouseDrag is called when the user has clicked on a Collider and is still holding down the mouse.
OnMouseEnter	Called when the mouse enters the Collider.
OnMouseExit	Called when the mouse is not any longer over the Collider.
OnMouseOver	Called every frame while the mouse is over the Collider.
OnMouseUp	OnMouseUp is called when the user has released the mouse button.
OnMouseUpAsButton	OnMouseUpAsButton is only called when the mouse is released over the same Collider as it was pressed.
OnPointerClick	Interface to implement if you wish to receive OnPointerClick callbacks.
OnPointerDown	Interface to implement if you wish to receive OnPointerDown callbacks.
OnPointerEnter	Interface to implement if you wish to receive OnPointerEnter callbacks.
OnPointerExit	Interface to implement if you wish to receive OnPointerExit callbacks.
OnPointerUp	Interface to implement if you wish to receive OnPointerUp callbacks.
OnNetDestroy	Triggered before network objects are destroyed.
OnSyncedVariablesUpdate	Triggered when synchronization variables are updated.