Inheritance diagram for Instigator:

[legend]

Public Member Functions
proto external void	SetInstigator (IEntity entity)
	Set instigator with automatic conversion from entity to player if necessary.

proto external void	SetInstigatorByPlayerID (int playerID)
	Will set the Instigator of type InstigatorType.Player.

proto external void	SetInstigatorTypeToGM ()
	Sets the instigator type to GM. PlayerID will be 0 and entity will be null.

proto external IEntity	GetInstigatorEntity ()
	Get the instigator entity, player ID will be automatically converted to current entity.

proto external int	GetInstigatorPlayerID ()
	Gets instigator player ID if the instigator is a player. Returns 0 otherwise.

proto external InstigatorType	GetInstigatorType ()
	Returns instigator type.

Static Public Member Functions
static proto ref Instigator	CreateInstigator (IEntity instigator)
	Proper way to create an instigator.

static proto ref Instigator	CreateInstigatorGM ()

Detailed Description

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

Member Function Documentation

◆ CreateInstigator()

static proto ref Instigator Instigator.CreateInstigator ( IEntity instigator )

static

Proper way to create an instigator.

◆ CreateInstigatorGM()

static proto ref Instigator Instigator.CreateInstigatorGM ( )

static

◆ GetInstigatorEntity()

proto external IEntity Instigator.GetInstigatorEntity ( )

Get the instigator entity, player ID will be automatically converted to current entity.

Can return null if the player is dead. e.g.: Players can wait on the respawn screen, and this will return null, don't rely on IEntity, use PlayerID instead

◆ GetInstigatorPlayerID()

proto external int Instigator.GetInstigatorPlayerID ( )

Gets instigator player ID if the instigator is a player. Returns 0 otherwise.

◆ GetInstigatorType()

proto external InstigatorType Instigator.GetInstigatorType ( )

Returns instigator type.

◆ SetInstigator()

proto external void Instigator.SetInstigator ( IEntity entity )

Set instigator with automatic conversion from entity to player if necessary.

◆ SetInstigatorByPlayerID()

proto external void Instigator.SetInstigatorByPlayerID ( int playerID )

Will set the Instigator of type InstigatorType.Player.

◆ SetInstigatorTypeToGM()

proto external void Instigator.SetInstigatorTypeToGM ( )

Sets the instigator type to GM. PlayerID will be 0 and entity will be null.

The documentation for this interface was generated from the following file:

Game/generated/Damage/Instigator.c

Public Member Functions

Static Public Member Functions