Snipe server API documentation

Snipe server is a proprietary technology for building massively multiplayer online games for social networks and mobile devices.

For getting started with Snipe server, take a look at our website and wiki.

  • snipe.cache package contains cache server core and modules;
  • snipe.edit package has editor functionality and core editor modules in it;
  • snipe.kit package contains documentation for Snipe Kit;
  • snipe.lib package contains various useful classes common to all server parts;
  • snipe.packages directory contains various Snipe server packages;
  • snipe.script package contains the base server-side script core class;
  • snipe.slave package has slave server core classes and modules;
  • snipe.stats package has the statistics gathering tool classes and modules;

Top Level

scripts
scripts_default
snipe
Array

An Array is a storage for values. You can access it using indexes or with its API.

ArrayAccess

ArrayAccess is used to indicate a class that can be accessed using brackets. The type parameter represents the type of the elements stored.

Bool

The standard Boolean type, which can either be true or false.

Class

An abstract type that represents a Class.

Date

The Date class provides a basic structure for date and time related information. Date instances can be created by

DateTools

The DateTools class contains some extra functionalities for handling Date instances and timestamps.

Dynamic

Dynamic is a special type which is compatible with all other types.

EReg

The EReg class represents regular expressions.

Enum

An abstract type that represents an Enum type.

EnumValue

An abstract type that represents any enum value. See Type for the Haxe Reflection API.

Float

The standard Float type, this is a double-precision IEEE 64bit float.

Int

The standard Int type. Its precision depends on the platform.

IntIterator

IntIterator is used for implementing interval iterations.

ItemProtoClass

Iterable

An Iterable is a data structure which has an iterator() method. See Lambda for generic functions on iterable structures.

Iterator

An Iterator is a structure that permits iteration over elements of type T.

Lambda

The Lambda class is a collection of methods to support functional programming. It is ideally used with using Lambda and then acts as an extension to Iterable types.

List

A linked-list of elements. The list is composed of element container objects that are chained together. It is optimized so that adding or removing an element does not imply copying the whole list content every time.

Map

Map allows key to value mapping for arbitrary value types, and many key types.

Math

This class defines mathematical functions and constants.

Null

Null can be useful in two cases. In order to document some methods that accept or can return a null value, or for the Flash compiler and AS3 generator to distinguish between base values that can be null and others that can't.

Reflect

The Reflect API is a way to manipulate values dynamically through an abstract interface in an untyped manner. Use with care.

Std

The Std class provides standard methods for manipulating basic types.

String

The basic String class.

StringBuf

A String buffer is an efficient way to build a big string by appending small elements together.

StringTools

This class provides advanced methods on Strings. It is ideally used with using StringTools and then acts as an extension to the String class.

Sys

This class gives you access to many base functionalities of system platforms. Looks in sys sub packages for more system APIs.

ThreadName

Type

The Haxe Reflection API allows retrieval of type information at runtime.

UserClass

ValueType

Void

The standard Void type. Only null values can be of the type Void.