-
Notifications
You must be signed in to change notification settings - Fork 8
Fields and Properties
Explaining every field/property from the Callouts (base) class. Some of these should never be edited,assigned and/or used.
Usage status shows you which field/property you need to use and avoid. Do not use means you should never edit it's value, but you may read it.
As the API is still in Beta, these might change in the future.
Type: List<Ped>
Usage status: Required
By default, `AssignedPlayers` contains (Ped) the client who received the callout. If the player requests for backup and someone accepts it, the new player will also be added. Only assigned players can start a call, so if someone gets close enough and the list does not contain the player, the call won't start.
There is an event for detecting new players in the call. Players are automatically added/removed, so** you should leave** it as is.
PS: It will be changed in a later version to Player instead of Ped.
public List<Ped> AssignedPlayers;Type: string
Usage status: Required
The description of the callout that will be displayed in the computer (in the detailed view)
public string CalloutDescription;Type: string
Usage status: Required
The shortname of the callout that is displayed as a notification header.
public string ShortName;Type: string
Usage status: Do not use
Case ID is a unique identifier. If someone wants to save the callout after completing it, this ID will be the ID in the database., otherwise thrown away. Case ID will be generated automatically., so you should not use it.
public string CaseID;Type: uint
Usage status: Optional
The amount of XP that each assigned player receive after completing the call.
XP is part of the progression system. Server owners have the ability to enable/disable XP from callouts, so it won't be counted in the player's progression.
Note: [0,uint.MaxValue]
public uint XP;Type: int
Usage status: Required
This code will be displayed in the computer (detailed view). If the response code is 3, the color of the text will be red, otherwise yellow.
public int ResponseCode;Type: float
Usage status: Required
How far a player needs to be to trigger the call. Note: Players from `AssignedPlayers` can only trigger the call.
public float StartDistance;Type: Vector3
Usage status: Required
Location of the callout. This position will be marked on the map and set as a waypoint for the player(s).
public Vector3 Location;Type: Blip
Usage status: Do not use
This Blip will be displayed on the map. The properties of the blip (eg. color, range, ...) can be set in the OnAccept method.
public Blip Marker;Type: string
Usage status: Do not use
Identifier is a globally unique identifier (GUID). It is used to identify a callout in the computer. It's being set automatically, so** do not use** it.
public string Identifier;Type: bool
Usage status: Do not use
Started will be true automatically once the callout starts (a player is in range from AssignedPlayers). It's used by the CalloutManager the determine whether a player can receive XP or not.
public bool Started;