Type Stargate
Stargate
Methods
| accessList( list ) | Restricts access to this gate to players/Steam IDs in the given list. |
| active() | Gets whether this gate is active. |
| address() | Gets this gate's address if it is visible. |
| addressList() | Gets a list of diallable addresses from this gate. |
| asuranBeam() | Gets whether an Asuran weapon is firing through this gate. |
| blocked() | Gets this gate's blocked state (shows as red in the dialling menu). |
| canDial( target ) | Gets whether this gate can dial the given target gate. |
| chevron() | Gets this gate's currently dialled chevron number. |
| chevrons() | Gets this gate's currently activated chevrons as a string. |
| close() | Closes this Stargate. |
| dhd() | Gets the DHD on this gate if it has one. |
| dial( target, mode ) | Dials this gate to another. |
| gateRing() | Gets the ring entity on SG1, infinity, movie and universe gates. |
| getSignal() | Gets the currently received signal on this gate. |
| group() | Gets this gate's group, if it is visible. |
| inbound() | Gets whether this gate has an inbound connection. |
| iris() | Gets the iris on this gate, if it has one. |
| listen( function ) | Adds a listener to this gate. |
| listenForCode( function ) | Adds an iris code listener for this gate. |
| listenForTeleport( function ) | Adds a teleport listener for this gate. |
| localgate() | Gets this gate's local mode state. |
| name() | Gets this gate's name, if it is visible. |
| open() | Gets whether this gate is open. |
| overloadPercent() | Gets the percentage this gate has been overloaded. |
| overloadTime() | Gets the time remaining before overloading. |
| overloading() | Gets whether this gate is being overloaded. |
| private() | Gets this gate's private state. |
| setAddress( address ) | Sets the address of this gate. |
| setBlocked( blocked ) | Sets the blocked state of this Stargate. |
| setGroup( group ) | Sets the group of this Stargate. |
| setLocal( local ) | Sets the local state of this Stargate. |
| setName( name ) | Sets the name of this Stargate. |
| setPrivate( private ) | Sets the private state of this Stargate. |
| setSGC( sgc ) | Sets the SGC mode of this Stargate. |
| sgc() | Gets this gate's SGC mode state (applicable to milky-way gates only). |
| stop( function ) | Removes a gate network listener from this gate. |
| stopCodeListen( function ) | Removes a listener for iris codes from this gate. |
| stopTeleListen( function ) | Removes a listener for teleporting entities from this gate. |
| target() | Gets the gate connected to this gate. |
| transmit( data ) | Transmits the given string data through this Stargate's connection. |
| unstable() | Gets whether this Stargate's event horizon is currently unstable. |
Methods
- Stargate:accessList( list )
-
Restricts access to this gate to players/Steam IDs in the given list.
Environment:
ServerParameters:
-
list: A table of players and/or Steam IDs to allow. Anyone else is blocked.
Return values:
-
(boolean)True if the access list is applied. -
(string)If the access list is not applied, the reason why.
-
- Stargate:active()
-
Gets whether this gate is active.
Environment:
ServerReturn value:
(boolean)True if this gate is currently active, false otherwise. - Stargate:address()
-
Gets this gate's address if it is visible.
Environment:
SharedReturn value:
(string)The address of this gate, if it is visible. Otherwise an empty string. - Stargate:addressList()
-
Gets a list of diallable addresses from this gate.
Environment:
ServerReturn value:
(tableA table containing a list of gate addresses that are available to dial.) - Stargate:asuranBeam()
-
Gets whether an Asuran weapon is firing through this gate.
Environment:
ServerReturn value:
(boolean)True if an Asuran weapon is being fired through this gate, false otherwise. - Stargate:blocked()
-
Gets this gate's blocked state (shows as red in the dialling menu).
Environment:
SharedReturn value:
(boolean)True if this gate is set to be blocked, false otherwise. - Stargate:canDial( target )
-
Gets whether this gate can dial the given target gate.
Environment:
ServerParameters:
-
target: The gate being dialled.
Return values:
-
(boolean)True if it can be dialled, false otherwise. -
(string)If the target cannot be dialled, the reason why.
-
- Stargate:chevron()
-
Gets this gate's currently dialled chevron number.
Environment:
ServerReturn value:
(number)The currently dialled chevron number (between 0 to 9). - Stargate:chevrons()
-
Gets this gate's currently activated chevrons as a string. Emulates the "Chevrons [STRING]" output.
Environment:
ServerReturn value:
(string)A string containing the currently active chevrons. - Stargate:close()
-
Closes this Stargate.
Environment:
ServerReturn values:
-
(boolean)True if this gate was closed, false otherwise. -
(string)If this gate was not closed, the reason why.
-
- Stargate:dhd()
-
Gets the DHD on this gate if it has one.
Environment:
ServerReturn value:
(Entity | nil)The DHD associated with this gate, if it exists. - Stargate:dial( target, mode )
-
Dials this gate to another.
Environment:
ServerParameters:
-
target: String address to dial to. -
mode: The mode with which to dial. One of the stargate.DIAL_MODE_* enum values.
Return values:
-
(boolean)True if the gate was dialled, false otherwise. -
(string)If the gate was not dialled, the reason why.
-
- Stargate:gateRing()
-
Gets the ring entity on SG1, infinity, movie and universe gates.
Environment:
ServerReturn value:
(Entity | nil)The entity that represents the ring on this gate, if it exists. - Stargate:getSignal()
-
Gets the currently received signal on this gate.
Environment:
ServerReturn value:
(string)The string value for the signal receieved. - Stargate:group()
-
Gets this gate's group, if it is visible.
Environment:
SharedReturn value:
(string)This gate's group, if visible. Otherwise an empty string. - Stargate:inbound()
-
Gets whether this gate has an inbound connection.
Environment:
ServerReturn value:
(boolean)True if this gate currently has an inbound connection, false otherwise. - Stargate:iris()
-
Gets the iris on this gate, if it has one.
Environment:
ServerReturn value:
(Entity | nil)The iris on this gate, if it exists. - Stargate:listen( function )
-
Adds a listener to this gate.
Environment:
ServerParameters:
-
function: Function to run when this gate is dialled.
-
- Stargate:listenForCode( function )
-
Adds an iris code listener for this gate.
Environment:
ServerParameters:
-
function: Function to run when the code is received.
-
- Stargate:listenForTeleport( function )
-
Adds a teleport listener for this gate.
Environment:
ServerParameters:
-
function: Function to run when an entity teleports to this gate.
-
- Stargate:localgate()
-
Gets this gate's local mode state.
Environment:
SharedReturn value:
(boolean)True if this gate is set to local-only mode. False otherwise. - Stargate:name()
-
Gets this gate's name, if it is visible.
Environment:
SharedReturn value:
(string)The name of this gate, if it is visible. Otherwise an empty string. - Stargate:open()
-
Gets whether this gate is open.
Environment:
ServerReturn value:
(boolean)True if this gate is open, false otherwise. - Stargate:overloadPercent()
-
Gets the percentage this gate has been overloaded.
Environment:
ServerReturn value:
(number)A number between 0 and 100 indicating how much this gate has been overloaded. - Stargate:overloadTime()
-
Gets the time remaining before overloading.
Environment:
ServerReturn value:
(number)The time in seconds until this gate will overload. - Stargate:overloading()
-
Gets whether this gate is being overloaded.
Environment:
ServerReturn value:
(boolean)True if this gate is being overloaded, false otherwise. - Stargate:private()
-
Gets this gate's private state.
Environment:
SharedReturn value:
(boolean)True if this gate is private (and thus the address/group/name is hidden if not the owner), false otherwise. - Stargate:setAddress( address )
-
Sets the address of this gate.
Environment:
ServerParameters:
-
address: Address to set.
Return values:
-
(boolean)True if the address was set, false otherwise. -
(string)If the address was not set, the reason why.
-
- Stargate:setBlocked( blocked )
-
Sets the blocked state of this Stargate.
Environment:
ServerParameters:
-
blocked: Boolean blocked.
Return values:
-
(boolean)True if the blocked state was set, false otherwise. -
(string)If the blocked state was not set, the reason why.
-
- Stargate:setGroup( group )
-
Sets the group of this Stargate.
Environment:
ServerParameters:
-
group: Group to set.
Return values:
-
(boolean)True if the group was set, false otherwise. -
(string)If the group was not set, the reason why.
-
- Stargate:setLocal( local )
-
Sets the local state of this Stargate.
Environment:
ServerParameters:
-
local: Boolean local.
Return values:
-
(boolean)True if the local state was set, false otherwise. -
(string)If the local state was not set, the reason why.
-
- Stargate:setName( name )
-
Sets the name of this Stargate.
Environment:
ServerParameters:
-
name: Name to set.
Return values:
-
(boolean)True if the name was set, false otherwise. -
(string)If the name was not set, the reason why.
-
- Stargate:setPrivate( private )
-
Sets the private state of this Stargate.
Environment:
ServerParameters:
-
private: Boolean private.
Return values:
-
(boolean)True if the private state was set, false otherwise. -
(string)If the private state was not set, the reason why.
-
- Stargate:setSGC( sgc )
-
Sets the SGC mode of this Stargate.
Environment:
ServerParameters:
-
sgc: Boolean SGC mode.
Return values:
-
(boolean)True if the SGC mode was set, false otherwise. -
(string)If the SGC mode was not set, the reason why.
-
- Stargate:sgc()
-
Gets this gate's SGC mode state (applicable to milky-way gates only).
Environment:
ServerReturn value:
(boolean)True if this gate is set to use SGC dialling mode, false otherwise. - Stargate:stop( function )
-
Removes a gate network listener from this gate.
Environment:
ServerParameters:
-
function: Function to remove.
-
- Stargate:stopCodeListen( function )
-
Removes a listener for iris codes from this gate.
Environment:
ServerParameters:
-
function: Function to remove.
-
- Stargate:stopTeleListen( function )
-
Removes a listener for teleporting entities from this gate.
Environment:
ServerParameters:
-
function: Function to remove.
-
- Stargate:target()
-
Gets the gate connected to this gate.
Environment:
ServerReturn value:
(Stargate)The gate that is connected to this gate (either inbound or outbound). - Stargate:transmit( data )
-
Transmits the given string data through this Stargate's connection.
Environment:
ServerParameters:
-
data: String data to send through.
Return values:
-
(boolean)True if the data was transimitted, false otherwise. -
(string)If the data was not transmitted, the reason why.
-
- Stargate:unstable()
-
Gets whether this Stargate's event horizon is currently unstable.
Environment:
ServerReturn value:
(boolean)True if the event horizon is unstable, false otherwise.