@Login

From SphereWiki
Revision as of 11:26, 12 June 2009 by MrSugarCube (talk | contribs) (Created page with '==Description== This trigger fires when a player logs in to the server. Fires on: * Players ==References== The following object references are explicit...')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Description

This trigger fires when a player logs in to the server.


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
I The player who is logging in.
SRC The player who is logging in.


Arguments

The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

Argument In/Out Description
ARGN1 O If set to 1, welcome messages won't be displayed to the player (i.e. server description, client count, last logged date)
ARGN2 IO If set to 1, no messages will be displayed to the player (as above, but also includes guards notification)


Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
1 Prevents the player from logging in.