Interface: IXR_actor_stats

Actor statistics helpers exposed through the actor_stats namespace.

Methods

add_points()

add_points(
   this: void, 
   section: string, 
   detail_key: string, 
   count: number, 
   points: number): void;

Add actor statistic points with count and score.

Parameters

Parameter	Type	Description
this	void	-
section	string	Statistic section id.
detail_key	string	Detail key inside the section.
count	number	Count to add.
points	number	Points to add.

Returns

void

---

add_points_str()

add_points_str(
   this: void, 
   section: string, 
   detail_key: string, 
   value: string): void;

Add actor statistic points with a string value.

Parameters

Parameter	Type	Description
this	void	-
section	string	Statistic section id.
detail_key	string	Detail key inside the section.
value	string	String value to add.

Returns

void

---

get_points()

get_points(this: void, section: string): number;

Get total actor points for a statistic section.

Parameters

Parameter	Type	Description
this	void	-
section	string	Statistic section id.

Returns

number

Section points.

---

remove_from_ranking()

remove_from_ranking(this: void, object_id: number): Nullable<void>;

Remove an object from actor ranking when this optional binding exists.

Parameters

Parameter	Type	Description
this	void	-
object_id	number	Object id to remove.

Returns

Nullable<void>