neosjs-headless-interface 2.3.1

neosjs-headless-interface

2.3.1

Neos.js Plugin - HeadlessInterface ▸
- Static members
- .neosjs-headless-interface
HeadlessInterface ▸
- Instance members
- #AcceptFriendRequest
- #AccessLevel
- #Ban
- #CanSend
- #Close
- #ExitLog
- #Focus
- #FriendRequests
- #GC
- #Invite
- #Kick
- #Kill
- #Login
- #Message
- #Respawn
- #Restart
- #Role
- #Run
- #RunCommand
- #Save
- #SaveConfig
- #SessionID
- #sessionId
- #SessionURL
- #Silence
- #StartLog
- #StartWorldTemplate
- #StartWorldURL
- #State
- #Status
- #Unban
- #Unsilence
- #Users
- #Worlds
- Events
- ⓔ HeadlessInterface#message
- ⓔ HeadlessInterface#ready

Need help reading this?

Neos.js Plugin - HeadlessInterface

This is a placeholder

Neos.js Plugin - HeadlessInterface

Static Members

▸ neosjs-headless-interface

Neos.js Plugin - HeadlessInterface

neosjs-headless-interface

Author: Bitman

Returns

HeadlessInterface:

Parent Library: Neos.js

HeadlessInterface

new HeadlessInterface()

Extends EventEmitter

Instance Members

▸ AcceptFriendRequest(user)

Accept a friend request

AcceptFriendRequest(user: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

Returns

Promise<String>:

▸ AccessLevel(accessLevel)

Set a new world access level

AccessLevel(accessLevel: String): Promise<String>

Since: 2.0.0

Parameters

accessLevel (String) accessLevel

Returns

Promise<String>:

▸ Ban(user)

Ban the given user

Ban(user: String): Promise<String>

Version: 2.3.1

Since: 2.0.0

Parameters

user (String) Username OR UserId

Returns

Promise<String>:

▸ CanSend

Can the headless client send another command right now?

CanSend

Deprecated: 2.1.0

Since: 1.0.0

▸ Close()

Close the currently focused world

Close(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ ExitLog()

Exit Async Logging Mode

ExitLog(): Promise<String>

Since: 2.2.0

Returns

Promise<String>:

▸ Focus(world)

Focus world

Focus(world: (Number | String)): Promise<String>

Since: 2.0.0

Parameters

world

((Number
													|
													String))

world name or number

Returns

Promise<String>:

▸ FriendRequests()

List all incoming friend requests

FriendRequests(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ GC()

Forces a full garbage collection

GC(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ Invite(user)

Invite a user to the server

Invite(user: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

Returns

Promise<String>:

▸ Kick(user)

Kick the given user from the session

Kick(user: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

Returns

Promise<String>:

▸ Kill()

End the Process

Kill(): any

Since: 1.0.0

Returns

any:

▸ Login(user, password)

Since: 2.0.0

Parameters

user (String) Username or Email

password (String) Password

Returns

Promise<String>:

▸ Message(user, message)

Send a message!

Message(user: String, message: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username to send message to

message (String) Message

Returns

Promise<String>:

▸ Respawn(user)

Respawn the given user

Respawn(user: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

Returns

Promise<String>:

▸ Restart()

Restart the current world

Restart(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ Role(user, role)

Assign a role to the given user

Role(user: String, role: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

role (String) UserRole

Returns

Promise<String>:

▸ Run(text)

Send a command to the Headless Client

Run(text: String): Promise<String>

Deprecated: since 2.0.1, Removing 2.2.0

Parameters

text (String)

Returns

Promise<String>:

▸ RunCommand(text)

Send a command to the Headless Client

RunCommand(text: String): Promise<String>

Version: 2.0.0

Since: 1.0.0

Parameters

text (String)

Returns

Promise<String>:

▸ Save()

Save the currently focused world

Save(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ SaveConfig(filename?)

Saves the current settings into the original config file Usage: SaveConfig(filename) (optional, will save in place without)

SaveConfig(filename: String?): Promise<String>

Since: 2.0.0

Parameters

filename (String?)

Returns

Promise<String>:

▸ SessionID()

Get the ID of the current session

SessionID(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ sessionId

Get the Headless Client SessionId

sessionId

Version: 2.0.0

Since: 1.0.0

▸ SessionURL()

Get the URL of the current session

SessionURL(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ Silence(user)

Silence the given user

Silence(user: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

Returns

Promise<String>:

▸ StartLog()

Enter Async Extended Logging Mode Use .on("message", ()=>{}) to get outputs. Commands can not run properly while in logging mode. (Yet)

StartLog(): Promise<String>

Since: 2.2.0

Returns

Promise<String>:

HeadlessInterface#message

▸ StartWorldTemplate(template)

Start a new world from template

StartWorldTemplate(template: String): Promise<String>

Since: 2.0.0

Parameters

template (String) template

Returns

Promise<String>:

▸ StartWorldURL(record)

Start a world with a url

StartWorldURL(record: String): Promise<String>

Since: 2.0.0

Parameters

record (String) World Record URL

Returns

Promise<String>:

▸ State

Only Guarenteed to be filled after HeadlessInterface#ready has fired

State

Properties

State

({Running:
												Boolean, Ready:
												Boolean, Starting:
												Boolean, CompatibilityHash:
												String, MachineID:
												String, log:
												Boolean, logMsg:
												Number, sessionId:
												String, sessionIdAttempts:
												Number})

▸ Status()

Show the status of the current world

Status(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ Unban(user)

Unban the given user

Unban(user: String): Promise<String>

Version: 2.3.1

Since: 2.0.0

Parameters

user (String) Username OR UserId

Returns

Promise<String>:

▸ Unsilence(user)

Remove silence from the given user

Unsilence(user: String): Promise<String>

Since: 2.0.0

Parameters

user (String) Username

Returns

Promise<String>:

▸ Users()

Lists all users in the world

Users(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

▸ Worlds()

List all active worlds

Worlds(): Promise<String>

Since: 2.0.0

Returns

Promise<String>:

Events

▸ HeadlessInterface#message

HeadlessInterface#message

Type: String

Properties

message (String) : Output from NeosClient

▸ HeadlessInterface#ready

Fires when the headless client is Ready

HeadlessInterface#ready

Type: String

Properties

sessionId (String) : SessionId of the started world