Name Help File

Name Help File

Plugin Name:

Name

Current Version:

1.0.0.0

Description:

Generates random names from a series of pre-defined name creation functions as well as allowing selection from a list of stored names.

Licence:

GNU GPL v3

Author:

Centauri Soldier

Web:

www.AMSPublic.com

E-mail:

CentauriSoldier@AMSPublic.com

Copyright:

Copyright © 2010 AMSPublic.com

Install Notes:

Place the "Name" folder in your "AutoPlay Media Studio\Plugins\Action" folder.


Table of Contents

Name.Generate
Name.GetNames
Name.GetRandom

Name.Generate


(string) Name.Generate ( 

(number) Type = NAME_TYPE_VOWEL,

(number) Length = 5 )

Description

Generates a random name from a series of pre-definded functions, offering a unique result.

Parameters

Type

(number) The type of sound with which the name will start.

CONSTANT

VALUE

DESCRIPTION

NAME_TYPE_VOWEL

1

NA

NAME_TYPE_CONSONANT

2

NA

NAME_TYPE_DOUBLE_VOWEL

3

NA

NAME_TYPE_DOUBLE_CONSONANT

4

NA

Length

(number) The length of the genreated name.

Returns

(string)
Retruns a random name as a string.


Name.GetNames


(table) Name.GetNames ()

Description

Gets the list of stored names.

Returns

(table)
Returns a table index by "Female" and "Male".
Each of those indexes are indexed by upper-case letters of the alphabet.
Each of those letters is a numerically-indexed table containing the names.


Example

local tNames = Name.GetNames();

Dialog.Message("Test", tNames["Male"]["C"][44]);



Name.GetRandom


(string) Name.GetRandom ( 

(string) Class = "Male",

(string) Letter = "*" )

Description

Gets a random name from the list of stored names.

Parameters

Class

(string) Female or Male (or both).

CONSTANT

VALUE

DESCRIPTION

"Female"

"Female"

NA

"Male"

"Male"

NA

"*"

"*"

Both Female and Male

Letter

(string) The letter with which the name should start.

CONSTANT

VALUE

DESCRIPTION

"A"

NA

NA

"B"

NA

NA

"C"

NA

NA

"D"

NA

NA

"E"

NA

NA

"F"

NA

NA

"G"

NA

NA

"H"

NA

NA

"I"

NA

NA

"J"

NA

NA

"K"

NA

NA

"L"

NA

NA

"M"

NA

NA

"N"

NA

NA

"O"

NA

NA

"P"

NA

NA

"Q"

NA

NA

"R"

NA

NA

"S"

NA

NA

"T"

NA

NA

"U"

NA

NA

"V"

NA

NA

"W"

NA

NA

"X"

NA

NA

"Y"

NA

NA

"Z"

NA

NA

"*"

NA

Choose from all letters

Returns

(string)
Retruns a random name as a string.



Copyright © 2010 AMSPublic.com
This File Was Generated With AMS ActionFile Editor