ldoc

• Index

Contents

• Functions
• Tables
• Fields

Modules

• script.client
• script.helpers.c_functions
• script.helpers.g_functions
• script.helpers.s_functions
• script.server

Module script.server

Server module for Advanced Roleplay Environment.

Functions

StartUp ()	Called on start up
ScanFramework ()	Scans the framework and sets the FRAMEWORK variable
ValidateSource (source)	Validates the source of a player
ValidateDistanceCheck (source, target)	Returns true if the player is near of the other
ValidateAuthToken (source, providedAuthToken)	Validates a auth token
Play3DSound (source, coords, distance, sound)	Plays a 3d sound to every player
Stop3DSound (source)	Stops a 3d sound to every player
SavePlayers ()	Saves all players
GetRealIdentifier (source)	Gets real identifier from a player

Tables

FRAMEWORK_DATA	table: Contains the framework object
SOUND_DATA	table: Contains the sound data

Fields

PRODUCT_NAME	string: Contains the product name of the script
CURRENT_VERSION	string: Contains the current version of the script
RELEASE_CANDIDATE	bool: Contains whether the script is a release candidate or not
FRAMEWORK	string: Contains the framework string

Functions

StartUp ()

Called on start up

ScanFramework ()

Scans the framework and sets the FRAMEWORK variable

ValidateSource (source)

Validates the source of a player

Parameters:

• source any

Returns:

boolean

ValidateDistanceCheck (source, target)

Returns true if the player is near of the other

Parameters:

• source
• target

ValidateAuthToken (source, providedAuthToken)

Validates a auth token

Parameters:

• source any
• providedAuthToken any

Returns:

boolean

Play3DSound (source, coords, distance, sound)

Plays a 3d sound to every player

Parameters:

• source any
• coords any
• distance any
• sound any

Returns:

boolean

Stop3DSound (source)

Stops a 3d sound to every player

Parameters:

• source any

Returns:

boolean

SavePlayers ()

Saves all players

GetRealIdentifier (source)

Gets real identifier from a player

Parameters:

• source any

Returns:

unknown

Tables

FRAMEWORK_DATA

table: Contains the framework object

SOUND_DATA

table: Contains the sound data

Fields

PRODUCT_NAME

string: Contains the product name of the script

CURRENT_VERSION

string: Contains the current version of the script

RELEASE_CANDIDATE

bool: Contains whether the script is a release candidate or not

FRAMEWORK

string: Contains the framework string