File /secure/simul_efun/pk_check.c

Written by Pinkfish

Includes

Method index

• pk_assist(mixed, mixed, int)
  This method checks to see if both of the objects are able to assist each other.
• pk_check(mixed, mixed, int)
  This method checks to see if both of the objects are able to do a pk action on each other.

Public Functions

These are functions that everyone can access.

.

pk_assist

int pk_assist(mixed assister,
              mixed assistee,
              int off_line)


This method checks to see if both of the objects are able to assist each other. This will return 1 if they cannot complete the action and 0 They are not able to assist each other if one of them is not PK and the other is and the PK is in combat with other players.

If an object is passed into this method, it is first checked with the method query_owner_pk_check(), if this returns a non-zero value it is used as the person who owns the object. This allows objects to be pk checked when they are not players.


• Parameters:
  assister - thing doing the assisting
  assistee - thing being assisted
• Returns:
  1 if they cannot attack each other

pk_check

int pk_check(mixed thing1,
             mixed thing2,
             int off_line)


This method checks to see if both of the objects are able to do a pk action on each other. This will return 1 if they cannot complete the action, ie: either of them are not player killers. It will take an object or a string as the first parameter and attempt to check for pkness, if the off_line flag is set it will even check for players that are not even logged on.

If an object is passed into this method, it is first checked with the method query_owner_pk_check(), if this returns a non-zero value it is used as the person who owns the object. This allows objects to be pk checked when they are not players.


• Parameters:
  thing1 - first object to check
  thing2 - second object to check
  off_line - allow the check to occur if they are not logged on
• Returns:
  1 if they cannot attack each other