Star Wars Combine :: Game Guide - User contributions [en]

Cloning Creatures

2026-09-18T22:22:11Z

Ruben Wan: /* How does it work? */

==Who can clone?==
The ability to clone can be acquired by anyone who completes a specific quest. In order to start the quest, you must enter any research station that is set to open-to-all, or any research centre that is powered and open-to-all.

The quest involves some fights, therefore it is suggested to have a squad of well-equipped military NPCs to help you. It is also possible to fight together with other characters.

Your character's skills are not required. The only skill that is taken into account during cloning is Medical Treatment, and it affects the number of concurrent clonings. If you have 0, you can still clone one creature, and if you have 5 you can clone 6 creatures simultaneously.

==How does it work?==
You must start by cloning Tiny creatures before unlocking the cloning for Small creatures. The order of cloning is the same as the order of size: Tiny, Small, Medium, Large, Huge, Colossal.

Improving your Research Level unlocks bigger sizes. For example, after cloning *successfully* 12 tiny creatures you can start cloning Small creatures as well.

To start the actual cloning, you must have two creatures of the same type. The DNA synthesis can fail or be successful, and it lasts 5 (five) days. Cloning costs credits, with discounts for higher Research Levels, and time is dependent upon the creature's size.

Cloning Creatures

2026-09-18T22:18:17Z

Ruben Wan: Created page with "==Who can clone?== The ability to clone can be acquired by anyone who completes a specific quest. In order to start the quest, you must enter any research station that is set to open-to-all, or any research centre that is powered and open-to-all. The quest involves some fights, therefore it is suggested to have a squad of well-equipped military NPCs to help you. It is also possible to fight together with other characters. Your character's skills are not required. The o..."

Main Page

2026-09-18T22:03:23Z

Ruben Wan: added link Cloning Creatures

{| style="padding: 0px; margin: 5px 0px; width: 100%; border: 1px solid #000033"
| style="width: 100%; text-align: center;" |
 Welcome to the [[Star Wars Combine]] - Guide 
It should serve you as a help in [[:Category:Getting Started|getting started]] in the browser-based [[Glossary#M|MMORPG]] in its own [http://holocron.swcombine.com/wiki/Main_Page Star Wars Universe] 
Check the [[FAQ|Frequently Asked Questions]] - for further help, try [[IRC|#swc-help]] 
|}
{| style="width: 100%; background-color: inherit; height: 100%; vertical-align: top;"
| style="width: 55%;" |
{| style="width: 100%; height: 100%; border: 1px solid #000033; background-color: ##003366; vertical-align: top;"
|
{| style="width: 98%; margin-left: 1%; padding: 1%; border: 1px solid black; background-color: #000f19;"
| style="width: 100%;" | First time?
|}
|-
|
{| style="width: 80%; height: 100%; margin-left: 5%; vertical-align: top; border: 1px solid #111111; background-color: #003750;"
| style="width: 80%;" | If this is your first time playing [[SWC]], it will be beneficial to look through the [[:Category: Getting Started|Getting Started]] and [[Tutorial Quests|Tutorial Quest Guide]] sections to get a broad understanding of some of the basic principles of the game. Once you have understood these, you should check out the [[Golden Rule]] and [[Glossary|Our Languages]] before moving to the Basic Activities and then Advanced Activities listed.
|}
|-
|
{| style="width: 98%; margin-left: 1%; padding: 1%; border: 1px solid black; background-color: #000f19;"
| style="width: 100%;" | Basic activities in the Combine
|}
|-
|
{| style="width: 98%; margin-left: 1%; background-color: inherit;"
| style="width: 50%;" |
* '''[[:Category:Getting Started|Getting Started]]'''
* [[Tutorial Quests]]
* [[The Interface]]
* [[Travel]]
* [[NPC Transport]]
* [[Messages|Sending a Message]]
* [[Forums|Using the Forums]]
* [[Equipping Items]]
* [[Party|Managing a Party]]
* [[Inventory]]
* [[Search Profiles]]
* [[Drop your Character]]
|}
|}
| style="width: 45%;" |
{| style="width: 100%; height: 100%; border: 1px solid #000033; background-color: ##003366"
|
{| style="width: 98%; margin-left: 1%; padding: 1%; border: 1px solid #000033; background-color: #000f19; vertical-align: top"
| style="width: 100%;" | Help
|}
|-
|
{| style="width: 98%; margin-left: 1%; padding: 1%; background-color: inherit;"
| style="width: 50%;" |
* [[Combine Points]]
* [[IRC]]
* [[Wiki Guide Editing]]
* [[:Category:OOC|OOC]]
*[[Glossary]]
|}
|-
|
{| style="width: 98%; margin-left: 1%; margin-top 2%; padding: 1%; border: 1px solid #000033; background-color: #000f19"
| style="width: 100%;" | Advanced Activities
|}
|-
|
{| style="width: 98%; margin-left: 1%; padding: 1%; background-color: inherit;"
| style="width: 50%;" |
* [[Cloning Creatures]]
* [[Combat]]
* [[Construction]]
* [[Crafting]]
* [[Doors and Locks]]
* [[Medicine|Healing]]
* [[Hunting]]
* [[Eggs|Hatching eggs]]
* [[GNS|Publishing Galactic News]]
* [[Medicine]]
* [[Microjumping]]
* [[Mining]]
* [[Production]]
* [[Prospecting]]
* [[Recycling]]
* [[Repairing]]
* [[Scripting]]
* [[Squadrons]]
* [[The Force]]
* [[Trading]]

|}
|}
|}

[[Category: Administrative pages]]

Travel

2025-11-02T23:06:16Z

Ruben Wan: /* Hyper */

Travel is the group of actions you can perform that make your character move around the game world. There is a wide variety of different travel methods, and these are listed below.

==Set Travel==
This type of travel uses a set time or distance that does not vary whenever you use this method of travel. It also requires less knowledge (generally) of your destination than for Variable Travel.

===Cross Terrain===
This type of travel involves moving between different city or terrain squares on a planets surface. This is performed by the following set of instructions:

* ::Controls::
* Click [Enter Cockpit] or [Position], depending on whether you are in a ship/vehicle or on foot.
* Choose the [Travel] option in the center tool bar.
* Choose [Cross-Terrain] button to the left side, under the main map view.
* Choose the terrain/city square that is next to your current one that you wish to travel to.
* Click [Accept] and your travel will begin.

You can only initiate this type of travel when you are on the very edge of the city/terrain square (ie at (0,0), or (21,4) etc). You will not have the [Cross-Terrain] option if you are not. Also, planet terrains do no 'wrap-around' so if you are on the northern most terrain square on a planet (say, (0,0)), you will not be able to move north and appear at the terrain square at the bottom of the column, and nor does that work horizontally.

The distance is fixed at 200km between city/terrain squares, so travel time will vary depending on how fast you/your ship/your vehicle can travel at.

===Ascend/Descend===
This type of travel is used when moving to and from a planets surface. There are 2 steps, where you move from the planet's surface to the atmosphere level, and then a further jump from there to orbit, which is in the system layer where you can move around the rest of the system (see later). This is performed by the following set of instructions:

'''Planet Surface -> Atmosphere'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Choose [Ascend] button next to the ETA counter and [Accept] button.

'''Atmosphere -> Orbit'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Click the [Planet] button to the left, under the map view.
* Click the [Orbit] button roughly in the center of the screen.

'''Orbit -> Atmosphere'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Click the [Descend] button to the left, under the map view.
* Click the map to the right where you would like to land.
* Click the [Accept] button.

'''Atmosphere -> Planet Surface'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Click the [Descend] button to the left, under the map view.
* Click the map to the right where you would like to land.
* Click the [Accept] button.

All four modes of transport can be performed by any ship that has Flight-Grade Repulsorlifts equipped. Vehicles that have Flight-Grade Repulsorlifts equipped can only ascend to the Atmosphere and descend from there to the Planet's Surface. Travel time for all four modes is fixed at 1 hour, regardless of the speed of your ship/vehicle.

==Variable Travel==
Travel time for these modes of travel differ depending on what vehicle/ship you have, the distance that you are travelling and your skill in piloting (for that specific vehicle type).

===Room Travel===

Room travel is travelling within a facility or ship. Travel between rooms is instantaneous and can be achieved by clicking on the room which you wish to travel to. You can only travel to rooms which are connected to the room you are in with a doorway.

Travel can be impeded by doors, which can be installed by a toolkit. If a door is installed within a doorway, you will need either a password, a keycard containing the password, or an electronic lock breaker in order to bypass it.

Passwords can be reset at any time by the owner of entity the door is within.

There are 6 different room types:

{| Border="1"
|-
| [[File:Normal.gif|Normal Room]] || Normal Room - No special features.
|-
| [[File:Hangar.gif|Hangar Bay]] || Hangar Bay - Can board Vehicles stored within the entity here.
|-
| [[File:Docking.gif|Docking Bay]] || Docking Bay - Can board Ships stored within the entity here.
|-
| [[File:Entrance.gif|Entrance/Exit]] || Entrance/Exit Room - Can leave the entity/board nearby entities from here.
|-
| [[File:Cockpit.gif|Cockpit]] || Cockpit - Can enter the cockpit/building management page (If piloting the entity).
|-
| [[File:Medical.gif|Medical Room]] || Medical Room - Bacta tanks can be deployed here.
|}

===Ground Travel===

Ground travel is travelling within a city or on a terrain square. It can be accessed through both the position screen whilst on foot, or through the cockpit if at ground level in a ship or vehicle. Ground Travel allows you to travel through the streets of a city, or across terrain. Each 'Block' is 1km2 making terrain squares approximately 22km2 and facilities within cities enormous sprawling complexes many kilometres wide.

If on foot, travelling to another block can be achieved by clicking that block and clicking the "'''Go'''" button. Travelling on foot is very slow, due to the scale of the cities, and can often take hours to reach your destination.

If in a ship or a vehicle, travelling to another block can be achieved by selecting '''Travel''' >> '''City/Terrain''' >> Selecting the block from the lower map then clicking the "'''Go'''" button. Ships and Vehicles are restricted to 200km/h within cities, however, can travel at their full speed in open terrain.

===Atmospheric Travel===

Atmospheric travel is travelling within the atmosphere of a planet. It allows you to travel to other cities without cross terrain or ascending to orbit.

Certain vehicles can ascend to atmosphere, if they have the "Flight-Grade Repulsorlifts" trait.

To travel in atmosphere, you need to be in the atmosphere level of a planet, then '''Travel''' >> '''Atmosphere''' >> Select the terrain from the lower map, then click the "'''Go'''" button.

===Sublight Travel===

Sublight travel allows you to travel within a system. It can only be achieved by ships within the Space layer (orbit of a planet).

To travel within a system, you need to be in a system, in the cockpit of a ship, and click '''Travel''' >> '''Sublight''' >> Select the space or planet from the lower map, then click the "'''Go'''" button.

'''CAUTION''' Flying into suns can seriously harm your health, your ship and all occupants. Flying into suns, or 'Sunning', will kill your character and heavily damage the ship you are flying.

===Hyper===

Used by ships with hyperdrive to move from one system to another (or deep space).
Ships traveling in hyperspace do not appear on any map or scanners, nor will the scanners of the ship in hyperspace detect anything. Docking to or undocking from any ship in hyperspace is not possible.

To activate the hyperdrive you must be out of any planet gravity well. A gravity well is represented by a red area on a system map and is generated by planets, stars, black holes or Gravity Generators such as those found upon Interdictor Capital Class ships. From the ship cockpit click '''Travel''' >> '''Hyper''' >> select the destination (sector and system or coordinates), then click '''Go''' button.

[[File:travel.png]]

'''CAUTION!''' Aborting hyperspace travel is very risky and should only be used in an emergency!

Expert pilots use the [[microjumping]] method to shorten their travel times, planning their routes in advance.

===Astromech Droids===
Also, to avoid an hypertravel being aborted because the pilot boards another entity (e.g., vehicle or ship in the docking bay), Astromech droids can be used. The R2 type is a good one to assist piloting for freighters and smaller. The R3 is good for Corvettes and bigger.

The Astromech must be left in the cockpit, and if you need to board a vehicle or ship that's docked onboard, you can board it without the ship dropping from hyper travel.
[[Category: Game Features]]
[[Category: Basic Activities]]

Travel

2025-11-02T23:05:29Z

Ruben Wan: /* Hyper */

Travel is the group of actions you can perform that make your character move around the game world. There is a wide variety of different travel methods, and these are listed below.

==Set Travel==
This type of travel uses a set time or distance that does not vary whenever you use this method of travel. It also requires less knowledge (generally) of your destination than for Variable Travel.

===Cross Terrain===
This type of travel involves moving between different city or terrain squares on a planets surface. This is performed by the following set of instructions:

* ::Controls::
* Click [Enter Cockpit] or [Position], depending on whether you are in a ship/vehicle or on foot.
* Choose the [Travel] option in the center tool bar.
* Choose [Cross-Terrain] button to the left side, under the main map view.
* Choose the terrain/city square that is next to your current one that you wish to travel to.
* Click [Accept] and your travel will begin.

You can only initiate this type of travel when you are on the very edge of the city/terrain square (ie at (0,0), or (21,4) etc). You will not have the [Cross-Terrain] option if you are not. Also, planet terrains do no 'wrap-around' so if you are on the northern most terrain square on a planet (say, (0,0)), you will not be able to move north and appear at the terrain square at the bottom of the column, and nor does that work horizontally.

The distance is fixed at 200km between city/terrain squares, so travel time will vary depending on how fast you/your ship/your vehicle can travel at.

===Ascend/Descend===
This type of travel is used when moving to and from a planets surface. There are 2 steps, where you move from the planet's surface to the atmosphere level, and then a further jump from there to orbit, which is in the system layer where you can move around the rest of the system (see later). This is performed by the following set of instructions:

'''Planet Surface -> Atmosphere'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Choose [Ascend] button next to the ETA counter and [Accept] button.

'''Atmosphere -> Orbit'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Click the [Planet] button to the left, under the map view.
* Click the [Orbit] button roughly in the center of the screen.

'''Orbit -> Atmosphere'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Click the [Descend] button to the left, under the map view.
* Click the map to the right where you would like to land.
* Click the [Accept] button.

'''Atmosphere -> Planet Surface'''
* ::Controls::
* Click [Enter Cockpit].
* Choose the [Travel] option in the center tool bar.
* Click the [Descend] button to the left, under the map view.
* Click the map to the right where you would like to land.
* Click the [Accept] button.

All four modes of transport can be performed by any ship that has Flight-Grade Repulsorlifts equipped. Vehicles that have Flight-Grade Repulsorlifts equipped can only ascend to the Atmosphere and descend from there to the Planet's Surface. Travel time for all four modes is fixed at 1 hour, regardless of the speed of your ship/vehicle.

==Variable Travel==
Travel time for these modes of travel differ depending on what vehicle/ship you have, the distance that you are travelling and your skill in piloting (for that specific vehicle type).

===Room Travel===

Room travel is travelling within a facility or ship. Travel between rooms is instantaneous and can be achieved by clicking on the room which you wish to travel to. You can only travel to rooms which are connected to the room you are in with a doorway.

Travel can be impeded by doors, which can be installed by a toolkit. If a door is installed within a doorway, you will need either a password, a keycard containing the password, or an electronic lock breaker in order to bypass it.

Passwords can be reset at any time by the owner of entity the door is within.

There are 6 different room types:

{| Border="1"
|-
| [[File:Normal.gif|Normal Room]] || Normal Room - No special features.
|-
| [[File:Hangar.gif|Hangar Bay]] || Hangar Bay - Can board Vehicles stored within the entity here.
|-
| [[File:Docking.gif|Docking Bay]] || Docking Bay - Can board Ships stored within the entity here.
|-
| [[File:Entrance.gif|Entrance/Exit]] || Entrance/Exit Room - Can leave the entity/board nearby entities from here.
|-
| [[File:Cockpit.gif|Cockpit]] || Cockpit - Can enter the cockpit/building management page (If piloting the entity).
|-
| [[File:Medical.gif|Medical Room]] || Medical Room - Bacta tanks can be deployed here.
|}

===Ground Travel===

Ground travel is travelling within a city or on a terrain square. It can be accessed through both the position screen whilst on foot, or through the cockpit if at ground level in a ship or vehicle. Ground Travel allows you to travel through the streets of a city, or across terrain. Each 'Block' is 1km2 making terrain squares approximately 22km2 and facilities within cities enormous sprawling complexes many kilometres wide.

If on foot, travelling to another block can be achieved by clicking that block and clicking the "'''Go'''" button. Travelling on foot is very slow, due to the scale of the cities, and can often take hours to reach your destination.

If in a ship or a vehicle, travelling to another block can be achieved by selecting '''Travel''' >> '''City/Terrain''' >> Selecting the block from the lower map then clicking the "'''Go'''" button. Ships and Vehicles are restricted to 200km/h within cities, however, can travel at their full speed in open terrain.

===Atmospheric Travel===

Atmospheric travel is travelling within the atmosphere of a planet. It allows you to travel to other cities without cross terrain or ascending to orbit.

Certain vehicles can ascend to atmosphere, if they have the "Flight-Grade Repulsorlifts" trait.

To travel in atmosphere, you need to be in the atmosphere level of a planet, then '''Travel''' >> '''Atmosphere''' >> Select the terrain from the lower map, then click the "'''Go'''" button.

===Sublight Travel===

Sublight travel allows you to travel within a system. It can only be achieved by ships within the Space layer (orbit of a planet).

To travel within a system, you need to be in a system, in the cockpit of a ship, and click '''Travel''' >> '''Sublight''' >> Select the space or planet from the lower map, then click the "'''Go'''" button.

'''CAUTION''' Flying into suns can seriously harm your health, your ship and all occupants. Flying into suns, or 'Sunning', will kill your character and heavily damage the ship you are flying.

===Hyper===

Used by ships with hyperdrive to move from one system to another (or deep space).
Ships traveling in hyperspace do not appear on any map or scanners, nor will the scanners of the ship in hyperspace detect anything. Docking to or undocking from any ship in hyperspace is not possible.

To activate the hyperdrive you must be out of any planet gravity well. A gravity well is represented by a red area on a system map and is generated by planets, stars, black holes or Gravity Generators such as those found upon Interdictor Capital Class ships. From the ship cockpit click '''Travel''' >> '''Hyper''' >> select the destination (sector and system or coordinates), then click '''Go''' button.

[[File:travel.png]]

'''CAUTION!''' Aborting hyperspace travel is very risky and should only be used in an emergency!

Expert pilots use the [[microjumping]] method to shorten their travel times, planning their routes in advance.

Also, to avoid an hypertravel being aborted because the pilot boards another entity (e.g., vehicle or ship in the docking bay), Astromech droids can be used. The R2 type is a good one to assist piloting for freighters and smaller. The R3 is good for Corvettes and bigger.

The Astromech must be left in the cockpit, and if you need to board a vehicle or ship that's docked onboard, you can board it without the ship dropping from hyper travel.
[[Category: Game Features]]
[[Category: Basic Activities]]

FAQ

2025-10-31T22:00:15Z

Ruben Wan: /* Can I kill another character? */

==General Questions==

====What is the Star Wars Combine?====

The Star Wars Combine is an interactive online Star Wars simulation. People play the sim from diverse nations around the globe. The Star Wars Combine is 100% free of charge, and is a non-profit game.

In the Combine you will be allowed to create a character of your own with several different races to choose from. Upon character creation, you will have the option to join a group from a hefty list of candidates. Life in the Combine galaxy is just like stepping into George Lucas's epic Star Wars universe with the primary difference being that, in the Combine, there are none of the original Star Wars characters. No Luke Skywalker, no Leia Organa, no Mon Mothma, etc. However, the setting and general plot are the same, there is an ongoing war between the Galactic Empire and New Republic as well as plenty of other player-driven conflicts.

====What time period is the game set in? ====

Though it is difficult to assess the time in comparison to the movies (since events and people are different between the two), it has been generally agreed upon that this game is set within the area of Episode IV: A New Hope and Episode V: The Empire Strikes Back. However, with the new movies and new ideas, we will be incorporating ships and systems from them as well.

====What would make me choose to play this game? ====

The Star Wars Combine provides a unique gaming experience compared to other games in this modern era. Being that it is primarily a role playing (RP) game, much of the in-game history is written and dictated by the actions of our players. With just a few thousand active players, our community is relatively small but it provides ample opportunities for interaction and fun among players.

====What are CPs (Combine Points)? ====

The Combine Points are given to you by the admins for out of character (OOC) efforts you do to support and help the Star Wars Combine. Additionally, CPs are awarded each day that you log into SWC. You can exchange them for ships, vehicles and other inventory items (as they come available), some of which are only available through the CP exchange system.

====What does NPC mean?====

NPC = Non-Playing Characters. You can hire them to work for you, build ships, fight alongside you, etc.

====Can I kill another character? ====

Right now there is no direct way to kill a character. You can kill your character yourself by flying voluntarily into a sun or black hole, which also kills any other passengers located on that ship if the ship class is a Fighter, or Gunboat. For any other ship class, only the pilot is killed.

For more information you can read the Rules page: https://www.swcombine.com/rules/?Life_and_Death#How_can_you_die?

====Why are the prices of the ships higher than those shown in the rules area? ====

The prices shown in the rules area are the prices of production. The real prices depend on the traders and the in-game demand for ships.

====Can I have more than one character? ====

No, you are only allowed to have one character in the Combine. If your character dies you may create a new one after a period of time. Even if you leave your character for long periods of time, it is still best to try and log back in as that character or check with one of the administrators to see if your old character still exists before creating a new one.

====Can more than one player use the same computer? ====

Yes, but you must link the accounts via the Multi Self-Registration system. For more information check out https://www.swcombine.com/rules/?Character_Creation

====How can I remake my character? ====

Once a character is made in the Combine, it cannot be altered. The only ways a new character can be made is if your character dies or if you "drop" your character (you can find a link to "drop" your character by clicking the "Character" link on the side of the page). If stats are your concern, you are allowed a single re-roll prior to hitting level 3. Additionally, your skills may be upgraded as you progress in the game.

====Why must I wait a period of time to create a new character?====

This delay was set in order to keep Combine players from creating, killing, and then recreating characters in hopes of getting a Force-sensitive one.

====Who developed/is developing the Combine? ====

The current and former staff of Combine can be found on the Contacts page under the link "The SWC Team".

====Is the Combine affiliated with LucasArts/Disney?====

The Combine is an independent game created by a group of people that love Star Wars. They are not part of LucasArts/Disney.

====What are White Scenarios? ====

White scenarios are in-character (IC) role-playing scenarios that have members of the combine performing actions through the forums. GM's monitor the scenarios and perform actions with NPC's. In White Scenarios there are no repercussions for being involved. If you die in one, you will still be alive in the Combine. Depending on how well you role-play in the scenarios you will be given experience points (XPs). You can find scenarios through the community links RPG Centre under Portals.

====What Messaging System do most members use? ====

Most members use either the Combine messaging system (often referred to as "Darkness Message"), Discord, or SWC's IRC server. Currently, a directory of active Discord channels is maintained in the "General Talk" forum.

====What is IRC? ====

IRC is a instant messaging server. Some combine players use IRC as a primary form of communication to their factions.

====How do I register on IRC and what does it do? ====

Registering on IRC secures your user name to help make sure no one else can use it. To register you will need to type /msg NickServ REGISTER password e-mail (change e-mail and password to what you would like for them both [example /msg NickServ REGISTER 123456 example@hotmail.com) After this you’ll receive a conformation e-mail and every time you log in you will need to type in /msg NickServ IDENTIFY password

====What server do I go to on IRC? ====

irc.swc-irc.com

====How can I be in more than one IRC channel at once? ====

You will need to download an IRC chat client (e.g., mIRC from http://www.mirc.com ). Download and install this and you can be in as many channels as you want! It also has other handy features to make chatting easier.

====Can I also create a city?====

Anyone can create a city, yes. However, there are some requirements to construct a city. The terrain square you selected must be non-volcanic. Also, either you or your faction must posses the required amount of credits to build a city. It costs a minimum of 1,500,000 credits to build a city.

====I must travel to a system but I don't know where it is. ====

If you want to find out where a system, sector, planet or city you have to travel to is then you can look at the galaxy map. It is easy to navigate and can be found here: http://www.swcombine.com/rules/?Galaxy_Map

====How do I increase my skill points? ====

Every time you level, you receive a new skill point to use. These skill points can be allocated to your skills via the Character link on your right menu. However, such increases cannot be undone, and the definitions for skills which are not yet implemented may change in the future.

====How long does my character stay in combine if I am not active anymore? ====

Characters with XP Level 1 are wiped after 9 months of inactivity, all characters above Level 1 are retrievable at any time. Dead characters, however, can never be retrieved.

====This stat doesn't seem to do anything yet, why is it there? ====

Not all of the stats in the game have a use yet, but when the game is fully operational they will all have a use. You can view what your stats will be used for by reading through the various rules in the technical section.

====How much experience do I need to raise up my Experience Level?====

The needed experience is not the same for every level. To achieve level 2 you need 1000 experience, for level 3 - 3000. For level n you will need 1000 x (n-1) x n / 2. You can find a table with the experience points needed up to level 9 in the rules section.

====Can I create a new faction?====

Yes you can. To do so you will need to satisfy the conditions found on the Faction Creation rules.

==Technical Questions==

====What do I need to play the Combine in the terms of hardware, software, etc?====

A computer or smartphone capable of connecting to the Internet and a web browser.

====Do I have to download any software to play?====

No, all that you need is a browser.

==Rules Questions==

====Where can I find SWC's rules?====

You can find them and other information about the SWC at: https://www.swcombine.com/rules/

====What happens if I die?====

You lose all of your characters experience points, inventory and money. You will keep only your Combine Points and in three weeks you will be able to create a new character.

====Is theft allowed in the Combine? ====

Theft occurs in the Combine. How your character reacts or performs it is up to you.

====Why can I not change the details (like ownership) of a ship owned by a faction?====

You can only change a ship's information if you own it. Ships given by a faction for your use are a privilege, and being such are not owned by you. This action was implemented in order to prevent theft of a faction's property

====Is the Combine played in real time? ====

The Combine is played in delayed real time. For more information read https://www.swcombine.com/rules/?Timeframe

====What is spying and is it allowed?====

Spying is when you infiltrate a faction in order to gain information for another faction or person. Currently it is permitted under the rules. Full details on what you may and may not do in regards to spying can be found at http://www.swcombine.com/rules/?Spying .

====What are raw materials?====

Raw materials are the materials required to produce a certain piece of technology (ship, vehicle, weapon, etc.).

====How can I die?====

Currently, there are only a few ways to die: running a ship into a sun or black hole, aborting hyper travel and crashing into a celestial body, or getting your faction, or someone else, to execute you. Players may also "drop" their character to start a new one (the three week respawn timer still applies).

====How do I get raw materials?====

Raw materials can be mined or recovered via recycling. For mining, prospecting vehicles must be used to scan planets for deposits, and then a mining faction must construct a mine at the deposit location in order to mine the deposit for materials. For recycling, specific recycling entities must be used to break apart entities or wrecks into their basic materials.

==Getting Started Questions==

====Can I be a jedi?====

Every race has its own force probability, giving you a chance to be born force sensitive. But if you are not, then you can still become one later by gaining experience and levels.

====Why is the handle I selected declined?====

1: It has to sound like a word (Ex: "bgfive" or "imlame" would not be accepted, while "John doe" would be)

2: It can not be the name of an star wars character, although using the first or last names is allowed (Ex: "Luke skywalker is not a legal handle, but "Luke deacon" or "Mike skywalker" would be)

3: No titles in your handle are allowed (Ex: no "Sir" "Darth" "Princess" "Dr." etc...)

4: All handles must have a capital for the first letter of the name (Ex: "john doe" is not legit, but "John doe" is)

5: No special chars in it other then spaces, -, or ` (Ex: "John5 doe" would be illegal, but "John'ell doe" would work)

Each handle is unique; if it's too close to the name of another character it will be declined. (Ex: if you try to set your handle as "Jennifer Dreighton" it will automatically fail, since there already is a "Jennifer Dreighton"). You may have the same last name as another character, but you require their permission first. (Ex: There is a "Wilhelm von Ismay" and a "Victor von Ismay", but Wilhelm got Victor's permission before setting his last name to that).

====How do I log in? It keeps refreshing the page.====

First, use Lost Password to request a new password and log in with that. Be sure to paste or type it in exactly, as it is case sensitive.

If that fails, check to ensure that you are using the up to date version of your web browser. Clear your cache and make sure cookies are enabled.

If you are still having no luck, consider temporarily trying an alternate browser such as Opera (www.opera.com) or Mozilla (www.mozilla.org).

====How can I earn credits?====

1. You can join a faction that pays its members a salary and/or bonuses.

2. You can buy items and sell it for more.

3. You can collect CPs and exchange them for entities that can be sold for credits.

For more information, see the article on [[Credits]].

====How can I get a ship or vehicle? ====

In the beginning of your character's life, you will have the option of purchasing 3 ships for a very steep discount at the end of the tutorial, besides that, the easiest way of getting a ship or vehicle is by joining a faction and be assigned one. Later on when you have enough money you can buy another one for yourself. Another possibility is to exchange your CPs for some of the available ships and vehicles in the CP exchange.

====Which faction should I join?====

That depends on who you want your character to be - a rebel or an empire supporter, a bounty hunter, a trader, a pirate, a researcher, etc. If you want to fly an X-Wing or a Mon Calamari cruiser, then you should join the Rebel Alliance or one of its allies. If you prefer the Tie Fighters and the Star Destroyers then you should definitely join the Galactic Empire. Of course you can join any other faction as well, depending on your interests. And who says you have to join any at all?

====How do I get more Credits? ====

The easiest way is to join a faction and receive a salary. You can also exchange CPs for entities that can be sold for credits. Alternately, you can start your own business like transporting ships and passengers for credits. Another possibility is to get a loan from a Bank faction or from another player, if you find somebody willing to loan you money.

====How can I get off my starting planet?====

1. Make your way through the tutorial and purchase a ship.

2. Join a faction, most offer transport to the planet you'll be working on, or supply a ship to fly around in.

3. Buy a ride from another player or a transport faction, or rent a ship from another player/faction.

4. Save up CPs and exchange them for a ship.

5. Purchase a ship and have it moved to your location, to do this you'll need to earn some money first.

====How to change my location (travel)? ====

If you want to move from one position to another you have to go to position => travel => city => you can enter some coordinates. If you give coordinates from (0,0) to (21,21) when you are on foot (walking), you will travel only inside the city. If you want to go to another city, first move to the edge of your current city in the direction you would like to go. Then go to position => travel => cross terrain => then you can pick a position to where you want to go to.

====I just created my character and assigned skill points. Where do I go and what do I do?====

It's up to you. You can work alone and be a freelancer or you can join a faction. While being an independent freelancer may sound fun, it doesn't provide the benefits a faction does such as paychecks every month, a neat duty like piloting a ship or vehicle, and a place to call home. Visit http://www.swcombine.com/community/factions.php for more details on the various factions. If you are interested in a faction, it would not be a bad idea to check out that faction’s website, as well as contacting a member from the faction's recruiting office to get more information on that faction’s services and benefits.

==How to Questions==

====How can I gain CPs?====

The easiest way is to simply log in and play! You are awarded CPs every day that you log in. Suggesting planet descriptions, reporting bugs and typos, working on admin assignments or other ways of helping the development of the Combine can also be awarded.

====How can I improve my skills? ====

For every Experience Level you achieve, 1 skill point is added to your skill pool, which you can use to improve your skills, using the Character link on your right menu. However, skill increases cannot be undone, and it is possible that skill definitions for features not yet implemented may be changed in the future.

====How can I get more experience? ====

Experience points can be gained in many ways. Flying ships or piloting vehicles is a common method, it is also possible to gain them by mining or prospecting. Constructing buildings or stations gains an amount of experience. Small amounts are also awarded for certain achievements such as sending your first message or joining your first faction. Other ways may be added as the game develops.

====How can I send a message to another player? ====

Click on the Send message link in your menu (it looks like an envelope) then Send Message. Enter the handle of the recipient and enter the message itself.

====How can I send credits to another player? ====

Click on the display of your current credits total in the right hand menu. This should bring up the Transfer Credits screen. Enter the handle of the character or the name of the faction to receive the credits, then enter the amount and add a comment if you want. Finally click Transfer.

====How do I join a faction? ====

Click the Faction link on the right hand menu and then on Join Faction. Select the one you would want to join, add a message if you want, click submit and await further instructions. Generally allow up to 24-48 hours for a reply from the faction to see if you have been accepted or not.

====How do I launch a missile, fire my blaster or beat up a Wookiee? ====

Full-scale Player vs. Player (PvP) Combat is not yet implemented. It is possible to brawl with Brawler NPCs for experience points and factions have the ability to arrest and execute. Ground combat is currently in beta - there are a couple systems that allow PvP ground combat while Player vs. Environment (PvE) is implemented in every system - while space combat is in alpha - one may find space bandits hiding in asteroid fields in deep space.

====How do I report a bug? ====

If you encounter a bug, click on the "Report Bug" link at the bottom of the right side menu. Please browse though the list of bugs to make sure that the bug you are reporting is a new one. If you find that your bug is already listed, add a comment to it stating your problem as well.

====How can I support the Combine?====

There are many ways to support the Combine. You can join one of the many volunteer teams (Art, Descriptions, Development, QA) to help improve the game. You can report bugs and typos.

====How do I buy weapons/droids/items? ====

A few minor items can already be bought in Shop and Commerce Centre facilities. Shops can be found in most starting cities and are NPC-owned, while Commerce Centres are faction/player owned.

Otherwise, the majority of weapons, droids, and items can be purchased from the faction that produces them, which is displayed on the rules page for the item in question, or from players who already own them.

As an example, let's demonstrate a trade between two players. The person who buys the ship (Luke) has to contact the person who sells the ship (Han). Next, Luke has to pay for the ship by clicking on transaction sheet/credits transaction/transfer credits. Afterward, Luke must write the name of receiver, amount and communication and then choose the receiver type. When all this has been done, Luke solidifies the credit transfer by clicking on the "transfer" button. To give Luke his ship after receiving payment, Han has to click on "ships" in his personal inventory and choose who he wants to give the ship to (faction or person). Han must then select the ship Luke paid for and click on "Make Over."

Be warned that there are no guarantees for trading in the Combine and theft is an ever-present factor in the game.

====How do I enter a ship or vehicle?====

First, you have to be assigned to the crewlist or set as owner/commander/pilot of the ship or vehicle to be able to board it. Once that is taken care of, click on "Position", then "Enter". If the above parameters are met, you should be able to see the ship. Click "Board".

====How do I pilot a ship or vehicle? ====

After you have entered the ship or vehicle there will be a room map representing the layout of the entity in which you now reside. Find your way to the cockpit and a new button will appear on the side of the screen titled "Ship Controls" (or "Vehicle Controls"). Click that button and you will be taken to a new screen that will allow you to pilot your ship/vehicle.

====How do I travel in a ship?====

To move around within a ship, your status in the Control panel must be set to Position (as opposed to Cockpit -- see below).

To operate a ship, you first travel from the entrance room to the cockpit room. Once in the cockpit room, click "Ship Controls" (this option will only appear if you have been assigned as the pilot of the ship).

To lift off, hit the Travel button then Ascend. It takes an hour to reach (upper) atmosphere.

Once in the upper atmosphere, you need to reach orbit; this takes another hour. You do this from the Travel section by hitting Travel, then Orbit.

Once in orbit, you have to escape the gravity well of the planet you're orbiting; this is the section shaded in red on the display under Travel. Hit the Sublight button and click on some square that is not in the red. This should take roughly half an hour of travel.

Once out of the gravity well, you're free to go Hyper. Hit the Hyper button, then select from the menu of sectors (or choose a sector from the map of the galaxy), then select the desired system and Go.

NOTE: Don't try to abort once in Hyper. You can lose the ship and be killed that way, should you come out near a celestial body.

Upon entering a system, you'll be still a bit out from your destination planet; you'll have to hit Sublight and indicate which planet you want to go to.

Upon arrival at the planet, you're in orbit. You can, at that point, change over to any other ship also in orbit for which you are listed as a Crewmember. To do this, Travel to that room in the ship which has the exit, hit Board, and select from among ships to which you have entree.

To land a ship on the ground, you must reverse the lift-off procedure: First hit Travel, then Descend (and you can select your destination square on the planet); that takes an hour to put you in atmosphere. Once in atmosphere, you land by hitting Descend in the Travel section (and you can select your destination square in the city). Once landed, you can leave the ship by travelling to an exit room and hitting Board.

NOTE: Some planets are protected by shields and will require access to descend to the ground.

When you have been assigned as Pilot to a ship, you can then manage the crewlist. You do this with the Crewlist button on the bottom of the panel.

Summary:

Travel: Board
Control: Position: Travel to cockpit room
Control: Enter Cockpit

Travel: Ascend to atmosphere
Travel: Ascend to orbit
Travel: Sublight out of gravity well
Travel: Hyper to new system
Travel: Sublight to planet
Travel: Descend to atmosphere
Travel: Descend to ground

Control: Position: Travel to exit room
Travel: Board

FAQ

2025-10-31T16:53:31Z

Ruben Wan: /* Can I kill another character? */

==General Questions==

====What is the Star Wars Combine?====

The Star Wars Combine is an interactive online Star Wars simulation. People play the sim from diverse nations around the globe. The Star Wars Combine is 100% free of charge, and is a non-profit game.

In the Combine you will be allowed to create a character of your own with several different races to choose from. Upon character creation, you will have the option to join a group from a hefty list of candidates. Life in the Combine galaxy is just like stepping into George Lucas's epic Star Wars universe with the primary difference being that, in the Combine, there are none of the original Star Wars characters. No Luke Skywalker, no Leia Organa, no Mon Mothma, etc. However, the setting and general plot are the same, there is an ongoing war between the Galactic Empire and New Republic as well as plenty of other player-driven conflicts.

====What time period is the game set in? ====

Though it is difficult to assess the time in comparison to the movies (since events and people are different between the two), it has been generally agreed upon that this game is set within the area of Episode IV: A New Hope and Episode V: The Empire Strikes Back. However, with the new movies and new ideas, we will be incorporating ships and systems from them as well.

====What would make me choose to play this game? ====

The Star Wars Combine provides a unique gaming experience compared to other games in this modern era. Being that it is primarily a role playing (RP) game, much of the in-game history is written and dictated by the actions of our players. With just a few thousand active players, our community is relatively small but it provides ample opportunities for interaction and fun among players.

====What are CPs (Combine Points)? ====

The Combine Points are given to you by the admins for out of character (OOC) efforts you do to support and help the Star Wars Combine. Additionally, CPs are awarded each day that you log into SWC. You can exchange them for ships, vehicles and other inventory items (as they come available), some of which are only available through the CP exchange system.

====What does NPC mean?====

NPC = Non-Playing Characters. You can hire them to work for you, build ships, fight alongside you, etc.

====Can I kill another character? ====

Right now there is no direct way to kill a character. You can kill your character yourself by flying voluntarily into a sun or black hole, which also kills any other passengers located on that ship if the ship class is a Fighter, or Gunboat. For any other ship class, only the pilot is killed.

====Why are the prices of the ships higher than those shown in the rules area? ====

The prices shown in the rules area are the prices of production. The real prices depend on the traders and the in-game demand for ships.

====Can I have more than one character? ====

No, you are only allowed to have one character in the Combine. If your character dies you may create a new one after a period of time. Even if you leave your character for long periods of time, it is still best to try and log back in as that character or check with one of the administrators to see if your old character still exists before creating a new one.

====Can more than one player use the same computer? ====

Yes, but you must link the accounts via the Multi Self-Registration system. For more information check out https://www.swcombine.com/rules/?Character_Creation

====How can I remake my character? ====

Once a character is made in the Combine, it cannot be altered. The only ways a new character can be made is if your character dies or if you "drop" your character (you can find a link to "drop" your character by clicking the "Character" link on the side of the page). If stats are your concern, you are allowed a single re-roll prior to hitting level 3. Additionally, your skills may be upgraded as you progress in the game.

====Why must I wait a period of time to create a new character?====

This delay was set in order to keep Combine players from creating, killing, and then recreating characters in hopes of getting a Force-sensitive one.

====Who developed/is developing the Combine? ====

The current and former staff of Combine can be found on the Contacts page under the link "The SWC Team".

====Is the Combine affiliated with LucasArts/Disney?====

The Combine is an independent game created by a group of people that love Star Wars. They are not part of LucasArts/Disney.

====What are White Scenarios? ====

White scenarios are in-character (IC) role-playing scenarios that have members of the combine performing actions through the forums. GM's monitor the scenarios and perform actions with NPC's. In White Scenarios there are no repercussions for being involved. If you die in one, you will still be alive in the Combine. Depending on how well you role-play in the scenarios you will be given experience points (XPs). You can find scenarios through the community links RPG Centre under Portals.

====What Messaging System do most members use? ====

Most members use either the Combine messaging system (often referred to as "Darkness Message"), Discord, or SWC's IRC server. Currently, a directory of active Discord channels is maintained in the "General Talk" forum.

====What is IRC? ====

IRC is a instant messaging server. Some combine players use IRC as a primary form of communication to their factions.

====How do I register on IRC and what does it do? ====

Registering on IRC secures your user name to help make sure no one else can use it. To register you will need to type /msg NickServ REGISTER password e-mail (change e-mail and password to what you would like for them both [example /msg NickServ REGISTER 123456 example@hotmail.com) After this you’ll receive a conformation e-mail and every time you log in you will need to type in /msg NickServ IDENTIFY password

====What server do I go to on IRC? ====

irc.swc-irc.com

====How can I be in more than one IRC channel at once? ====

You will need to download an IRC chat client (e.g., mIRC from http://www.mirc.com ). Download and install this and you can be in as many channels as you want! It also has other handy features to make chatting easier.

====Can I also create a city?====

Anyone can create a city, yes. However, there are some requirements to construct a city. The terrain square you selected must be non-volcanic. Also, either you or your faction must posses the required amount of credits to build a city. It costs a minimum of 1,500,000 credits to build a city.

====I must travel to a system but I don't know where it is. ====

If you want to find out where a system, sector, planet or city you have to travel to is then you can look at the galaxy map. It is easy to navigate and can be found here: http://www.swcombine.com/rules/?Galaxy_Map

====How do I increase my skill points? ====

Every time you level, you receive a new skill point to use. These skill points can be allocated to your skills via the Character link on your right menu. However, such increases cannot be undone, and the definitions for skills which are not yet implemented may change in the future.

====How long does my character stay in combine if I am not active anymore? ====

Characters with XP Level 1 are wiped after 9 months of inactivity, all characters above Level 1 are retrievable at any time. Dead characters, however, can never be retrieved.

====This stat doesn't seem to do anything yet, why is it there? ====

Not all of the stats in the game have a use yet, but when the game is fully operational they will all have a use. You can view what your stats will be used for by reading through the various rules in the technical section.

====How much experience do I need to raise up my Experience Level?====

The needed experience is not the same for every level. To achieve level 2 you need 1000 experience, for level 3 - 3000. For level n you will need 1000 x (n-1) x n / 2. You can find a table with the experience points needed up to level 9 in the rules section.

====Can I create a new faction?====

Yes you can. To do so you will need to satisfy the conditions found on the Faction Creation rules.

==Technical Questions==

====What do I need to play the Combine in the terms of hardware, software, etc?====

A computer or smartphone capable of connecting to the Internet and a web browser.

====Do I have to download any software to play?====

No, all that you need is a browser.

==Rules Questions==

====Where can I find SWC's rules?====

You can find them and other information about the SWC at: https://www.swcombine.com/rules/

====What happens if I die?====

You lose all of your characters experience points, inventory and money. You will keep only your Combine Points and in three weeks you will be able to create a new character.

====Is theft allowed in the Combine? ====

Theft occurs in the Combine. How your character reacts or performs it is up to you.

====Why can I not change the details (like ownership) of a ship owned by a faction?====

You can only change a ship's information if you own it. Ships given by a faction for your use are a privilege, and being such are not owned by you. This action was implemented in order to prevent theft of a faction's property

====Is the Combine played in real time? ====

The Combine is played in delayed real time. For more information read https://www.swcombine.com/rules/?Timeframe

====What is spying and is it allowed?====

Spying is when you infiltrate a faction in order to gain information for another faction or person. Currently it is permitted under the rules. Full details on what you may and may not do in regards to spying can be found at http://www.swcombine.com/rules/?Spying .

====What are raw materials?====

Raw materials are the materials required to produce a certain piece of technology (ship, vehicle, weapon, etc.).

====How can I die?====

Currently, there are only a few ways to die: running a ship into a sun or black hole, aborting hyper travel and crashing into a celestial body, or getting your faction, or someone else, to execute you. Players may also "drop" their character to start a new one (the three week respawn timer still applies).

====How do I get raw materials?====

Raw materials can be mined or recovered via recycling. For mining, prospecting vehicles must be used to scan planets for deposits, and then a mining faction must construct a mine at the deposit location in order to mine the deposit for materials. For recycling, specific recycling entities must be used to break apart entities or wrecks into their basic materials.

==Getting Started Questions==

====Can I be a jedi?====

Every race has its own force probability, giving you a chance to be born force sensitive. But if you are not, then you can still become one later by gaining experience and levels.

====Why is the handle I selected declined?====

1: It has to sound like a word (Ex: "bgfive" or "imlame" would not be accepted, while "John doe" would be)

2: It can not be the name of an star wars character, although using the first or last names is allowed (Ex: "Luke skywalker is not a legal handle, but "Luke deacon" or "Mike skywalker" would be)

3: No titles in your handle are allowed (Ex: no "Sir" "Darth" "Princess" "Dr." etc...)

4: All handles must have a capital for the first letter of the name (Ex: "john doe" is not legit, but "John doe" is)

5: No special chars in it other then spaces, -, or ` (Ex: "John5 doe" would be illegal, but "John'ell doe" would work)

Each handle is unique; if it's too close to the name of another character it will be declined. (Ex: if you try to set your handle as "Jennifer Dreighton" it will automatically fail, since there already is a "Jennifer Dreighton"). You may have the same last name as another character, but you require their permission first. (Ex: There is a "Wilhelm von Ismay" and a "Victor von Ismay", but Wilhelm got Victor's permission before setting his last name to that).

====How do I log in? It keeps refreshing the page.====

First, use Lost Password to request a new password and log in with that. Be sure to paste or type it in exactly, as it is case sensitive.

If that fails, check to ensure that you are using the up to date version of your web browser. Clear your cache and make sure cookies are enabled.

If you are still having no luck, consider temporarily trying an alternate browser such as Opera (www.opera.com) or Mozilla (www.mozilla.org).

====How can I earn credits?====

1. You can join a faction that pays its members a salary and/or bonuses.

2. You can buy items and sell it for more.

3. You can collect CPs and exchange them for entities that can be sold for credits.

For more information, see the article on [[Credits]].

====How can I get a ship or vehicle? ====

In the beginning of your character's life, you will have the option of purchasing 3 ships for a very steep discount at the end of the tutorial, besides that, the easiest way of getting a ship or vehicle is by joining a faction and be assigned one. Later on when you have enough money you can buy another one for yourself. Another possibility is to exchange your CPs for some of the available ships and vehicles in the CP exchange.

====Which faction should I join?====

That depends on who you want your character to be - a rebel or an empire supporter, a bounty hunter, a trader, a pirate, a researcher, etc. If you want to fly an X-Wing or a Mon Calamari cruiser, then you should join the Rebel Alliance or one of its allies. If you prefer the Tie Fighters and the Star Destroyers then you should definitely join the Galactic Empire. Of course you can join any other faction as well, depending on your interests. And who says you have to join any at all?

====How do I get more Credits? ====

The easiest way is to join a faction and receive a salary. You can also exchange CPs for entities that can be sold for credits. Alternately, you can start your own business like transporting ships and passengers for credits. Another possibility is to get a loan from a Bank faction or from another player, if you find somebody willing to loan you money.

====How can I get off my starting planet?====

1. Make your way through the tutorial and purchase a ship.

2. Join a faction, most offer transport to the planet you'll be working on, or supply a ship to fly around in.

3. Buy a ride from another player or a transport faction, or rent a ship from another player/faction.

4. Save up CPs and exchange them for a ship.

5. Purchase a ship and have it moved to your location, to do this you'll need to earn some money first.

====How to change my location (travel)? ====

If you want to move from one position to another you have to go to position => travel => city => you can enter some coordinates. If you give coordinates from (0,0) to (21,21) when you are on foot (walking), you will travel only inside the city. If you want to go to another city, first move to the edge of your current city in the direction you would like to go. Then go to position => travel => cross terrain => then you can pick a position to where you want to go to.

====I just created my character and assigned skill points. Where do I go and what do I do?====

It's up to you. You can work alone and be a freelancer or you can join a faction. While being an independent freelancer may sound fun, it doesn't provide the benefits a faction does such as paychecks every month, a neat duty like piloting a ship or vehicle, and a place to call home. Visit http://www.swcombine.com/community/factions.php for more details on the various factions. If you are interested in a faction, it would not be a bad idea to check out that faction’s website, as well as contacting a member from the faction's recruiting office to get more information on that faction’s services and benefits.

==How to Questions==

====How can I gain CPs?====

The easiest way is to simply log in and play! You are awarded CPs every day that you log in. Suggesting planet descriptions, reporting bugs and typos, working on admin assignments or other ways of helping the development of the Combine can also be awarded.

====How can I improve my skills? ====

For every Experience Level you achieve, 1 skill point is added to your skill pool, which you can use to improve your skills, using the Character link on your right menu. However, skill increases cannot be undone, and it is possible that skill definitions for features not yet implemented may be changed in the future.

====How can I get more experience? ====

Experience points can be gained in many ways. Flying ships or piloting vehicles is a common method, it is also possible to gain them by mining or prospecting. Constructing buildings or stations gains an amount of experience. Small amounts are also awarded for certain achievements such as sending your first message or joining your first faction. Other ways may be added as the game develops.

====How can I send a message to another player? ====

Click on the Send message link in your menu (it looks like an envelope) then Send Message. Enter the handle of the recipient and enter the message itself.

====How can I send credits to another player? ====

Click on the display of your current credits total in the right hand menu. This should bring up the Transfer Credits screen. Enter the handle of the character or the name of the faction to receive the credits, then enter the amount and add a comment if you want. Finally click Transfer.

====How do I join a faction? ====

Click the Faction link on the right hand menu and then on Join Faction. Select the one you would want to join, add a message if you want, click submit and await further instructions. Generally allow up to 24-48 hours for a reply from the faction to see if you have been accepted or not.

====How do I launch a missile, fire my blaster or beat up a Wookiee? ====

Full-scale Player vs. Player (PvP) Combat is not yet implemented. It is possible to brawl with Brawler NPCs for experience points and factions have the ability to arrest and execute. Ground combat is currently in beta - there are a couple systems that allow PvP ground combat while Player vs. Environment (PvE) is implemented in every system - while space combat is in alpha - one may find space bandits hiding in asteroid fields in deep space.

====How do I report a bug? ====

If you encounter a bug, click on the "Report Bug" link at the bottom of the right side menu. Please browse though the list of bugs to make sure that the bug you are reporting is a new one. If you find that your bug is already listed, add a comment to it stating your problem as well.

====How can I support the Combine?====

There are many ways to support the Combine. You can join one of the many volunteer teams (Art, Descriptions, Development, QA) to help improve the game. You can report bugs and typos.

====How do I buy weapons/droids/items? ====

A few minor items can already be bought in Shop and Commerce Centre facilities. Shops can be found in most starting cities and are NPC-owned, while Commerce Centres are faction/player owned.

Otherwise, the majority of weapons, droids, and items can be purchased from the faction that produces them, which is displayed on the rules page for the item in question, or from players who already own them.

As an example, let's demonstrate a trade between two players. The person who buys the ship (Luke) has to contact the person who sells the ship (Han). Next, Luke has to pay for the ship by clicking on transaction sheet/credits transaction/transfer credits. Afterward, Luke must write the name of receiver, amount and communication and then choose the receiver type. When all this has been done, Luke solidifies the credit transfer by clicking on the "transfer" button. To give Luke his ship after receiving payment, Han has to click on "ships" in his personal inventory and choose who he wants to give the ship to (faction or person). Han must then select the ship Luke paid for and click on "Make Over."

Be warned that there are no guarantees for trading in the Combine and theft is an ever-present factor in the game.

====How do I enter a ship or vehicle?====

First, you have to be assigned to the crewlist or set as owner/commander/pilot of the ship or vehicle to be able to board it. Once that is taken care of, click on "Position", then "Enter". If the above parameters are met, you should be able to see the ship. Click "Board".

====How do I pilot a ship or vehicle? ====

After you have entered the ship or vehicle there will be a room map representing the layout of the entity in which you now reside. Find your way to the cockpit and a new button will appear on the side of the screen titled "Ship Controls" (or "Vehicle Controls"). Click that button and you will be taken to a new screen that will allow you to pilot your ship/vehicle.

====How do I travel in a ship?====

To move around within a ship, your status in the Control panel must be set to Position (as opposed to Cockpit -- see below).

To operate a ship, you first travel from the entrance room to the cockpit room. Once in the cockpit room, click "Ship Controls" (this option will only appear if you have been assigned as the pilot of the ship).

To lift off, hit the Travel button then Ascend. It takes an hour to reach (upper) atmosphere.

Once in the upper atmosphere, you need to reach orbit; this takes another hour. You do this from the Travel section by hitting Travel, then Orbit.

Once in orbit, you have to escape the gravity well of the planet you're orbiting; this is the section shaded in red on the display under Travel. Hit the Sublight button and click on some square that is not in the red. This should take roughly half an hour of travel.

Once out of the gravity well, you're free to go Hyper. Hit the Hyper button, then select from the menu of sectors (or choose a sector from the map of the galaxy), then select the desired system and Go.

NOTE: Don't try to abort once in Hyper. You can lose the ship and be killed that way, should you come out near a celestial body.

Upon entering a system, you'll be still a bit out from your destination planet; you'll have to hit Sublight and indicate which planet you want to go to.

Upon arrival at the planet, you're in orbit. You can, at that point, change over to any other ship also in orbit for which you are listed as a Crewmember. To do this, Travel to that room in the ship which has the exit, hit Board, and select from among ships to which you have entree.

To land a ship on the ground, you must reverse the lift-off procedure: First hit Travel, then Descend (and you can select your destination square on the planet); that takes an hour to put you in atmosphere. Once in atmosphere, you land by hitting Descend in the Travel section (and you can select your destination square in the city). Once landed, you can leave the ship by travelling to an exit room and hitting Board.

NOTE: Some planets are protected by shields and will require access to descend to the ground.

When you have been assigned as Pilot to a ship, you can then manage the crewlist. You do this with the Crewlist button on the bottom of the panel.

Summary:

Travel: Board
Control: Position: Travel to cockpit room
Control: Enter Cockpit

Travel: Ascend to atmosphere
Travel: Ascend to orbit
Travel: Sublight out of gravity well
Travel: Hyper to new system
Travel: Sublight to planet
Travel: Descend to atmosphere
Travel: Descend to ground

Control: Position: Travel to exit room
Travel: Board

Fitouts

2025-10-31T15:00:58Z

Ruben Wan: adding manual equipment

==Automatic NPC Equipment==
In order to equip many NPCs at a time, it is possible to use fitouts intead of equipping each NPC individually.

# Go to your Personal Inventory menu on the right hand side under your avatar and click the NPCs link.
# On the top left area of the screen there are several buttons: Sort by, Filter by, Export, Manage Tags, and Manage Fitouts. Click on the 'Manage Fitouts' button.
# The first time you will get the warning: "You have no NPC fitouts available. In order to create a fitout you must first create an NPC inventory tag." Therefore, click on the link "create an NPC inventory tag"
# The Tag Overview page will open up. At the bottom of that page click "Create"
# Name your tag as the NPC who will use the tag, or give a meaningful name to be used with squads. Example: If your NPC is named Bob Hope, then name the tag 'Bob Hope Fitout'. If you are equipping a Riflemen squad, then name the tag 'Riflemen Fitout'.
# Now click "personal NPC fitouts" at the top of the page.
# It will take you to a page with a box on the left of an equipment layout. Click the title of the box.
# You will be at the page with your equipment box on the left and listings of items on the right. Click the items and drag and drop them onto the equipment box as you wish to equip your NPCs. By adding different items to the same slots you create an order of preference for your NPCs to pickup for that slot.
# Now click the 'NPCs' link under your Personal Inventory again to be directed back to the NPC page. Click on the box for the NPC(s) you just made a tag for. A check should appear in the box. Scroll all the way down to the bottom of the page. Click 'Select Action'. Choose 'Assign Tag' from the drop-down menu. Copy/Paste the NPC's name in the box. Click 'Process'.
# When complete, go to your "Party" page. Place a check in the box of your NPC(s) and under 'Actions' scroll down to the desired action of your NPC(s) under one of the three fitout options: Drop All, Drop and Pickup, or Pickup Only. If the items you assigned to the NPC slots are in the same room of the NPCs, the NPCs will perform the desired action and equip themselves.

==Manual NPC Equipment==
It is possible to override an automatic fitout and equip a NPC manually, without the need to use inventory tags nor to create a new fitout.
To do so, you must Party with the NPC of your choice and click on "NPC Control". This option is listed in the menu "Control", between "Room Travel" and "Equipment". You can then equip the selected NPC as you do for yourself.

==Removing an Item from a Fitout==
This can be done by clicking the name of the item in the list below the silhouette that tells you which items are equipped where. This takes a while for it to load and remove it.

==Notes==
* Custom items cannot be equipped as fitouts.
* Every type of NPC can be equipped with fitouts, also the custom ones.
* If you cannot see the Manage Fitouts button then check your inventory view. The button is only visible in the Graphic Inventory view, not in the Tree view.
* click and drag --two times-- the icon for the item that you want to 'assign' onto the large 'slot' area
* there may be a delay of up to maybe 20 seconds or so for the 'system' to recognize the new item assigned, and for it to display on the slot area

[[Category:Features]]

Combine Points

2025-08-08T12:17:13Z

Ruben Wan: /* Activity */ corrected values of CPs in day 1 and 2

Combine Points (or CPs) are an OOC reward to players for helping the combine. There are a variety of ways of obtaining them, as well as uses for them. The number you currently have is shown on the sidebar, underneath your avatar and can be exchanged for a variety of [[ships]], [[vehicles]], [[droids]] and various other things.

==Getting CPs==
CPs are obtained from supporting the Combine in some way. Most players will get them from being active, while others will get them for helping with art, or descriptions etc.

===Activity===
This is the main method with which players will gain CPs, once per 24 hours, just for logging in/playing the game. The system currently works based on a window, where you must access the website between 24-48 hours after a reward to receive the next one, rather than using the calendar day to define the boundaries. The goal here is to help people who may only be able to play the game briefly on certain days, where that activity window may also overlap with the end of a calendar day according to the server, which could result in missed rewards. Continued activity over the course of multiple days will result in larger bonuses, capping at the maximum bonus on the 7th day without failure and every day after.

You do not need to actually "log in" with your username+password; the normal activity checker for counting online players will trigger the check for you when you access the game in your browser.

{|
|'''Activity Streak''' || '''CPs'''
|-
|1 Day || 320
|-
|2 Days || 370
|-
|3 Days || 420
|-
|4 Days || 470
|-
|5 Days || 520
|-
|6 Days || 570
|-
|7+ Days || 620
|}

===Helping===
You can get CPs for helping enhance the Combine in many different ways. Helping to update descriptions for entities, creating new art for SWC to use can all get you more CP's.

==Rewards==
There are many things you can exchange CPs for including:
*[http://www.swcombine.com/rules/?CP_Bonus_Ships CP Ships] - Ships with landing capacity must be spawned from inside a powered Starport or Landing Pad, whereas ships without landing capacity can only be purchased inside the following Space Stations: Trading I and Trading II, Shipyard I to IV, R&D I to IV.
*[http://www.swcombine.com/rules/?CP_Bonus_Vehicles CP Vehicles] - these must be spawned from inside a powered Garage, Hangar or Starport
*[http://www.swcombine.com/rules/?CP_Bonus_Droids CP Droids] - these must be spawned from inside a powered Tavern, Hangar, Shop, Commerce Center or Factory.
*Custom Items and [http://www.swcombine.com/rules/?NPCs#Custom_NPCs NPCs] (which exist solely for RP, and you can create your own [http://www.swcombine.com/rules/?Scripts script] for Custom NPCs)
*[[Custom_Images|Custom images]] for your entities, this is your chance to make your ship, speeder, item or anything else that you would like to look different to the norm, if you are no good at photoshopping there are multiple people in the game that you can hire for credits to create your customised paint job for you.
To exchange your points, find the [http://www.swcombine.com/members/cp/index.php?mode=exchange Exchange CPs] menu under the CP section on your sidebar in-game.

[[Category:OOC]]

Combine Points

2025-07-30T16:14:38Z

Ruben Wan: /* Rewards */ added text in CP Ships paragraph

Combine Points (or CPs) are an OOC reward to players for helping the combine. There are a variety of ways of obtaining them, as well as uses for them. The number you currently have is shown on the sidebar, underneath your avatar and can be exchanged for a variety of [[ships]], [[vehicles]], [[droids]] and various other things.

==Getting CPs==
CPs are obtained from supporting the Combine in some way. Most players will get them from being active, while others will get them for helping with art, or descriptions etc.

===Activity===
This is the main method with which players will gain CPs, once per 24 hours, just for logging in/playing the game. The system currently works based on a window, where you must access the website between 24-48 hours after a reward to receive the next one, rather than using the calendar day to define the boundaries. The goal here is to help people who may only be able to play the game briefly on certain days, where that activity window may also overlap with the end of a calendar day according to the server, which could result in missed rewards. Continued activity over the course of multiple days will result in larger bonuses, capping at the maximum bonus on the 7th day without failure and every day after.

You do not need to actually "log in" with your username+password; the normal activity checker for counting online players will trigger the check for you when you access the game in your browser.

{|
|'''Activity Streak''' || '''CPs'''
|-
|1 Day || 300
|-
|2 Days || 350
|-
|3 Days || 420
|-
|4 Days || 470
|-
|5 Days || 520
|-
|6 Days || 570
|-
|7+ Days || 620
|}

===Helping===
You can get CPs for helping enhance the Combine in many different ways. Helping to update descriptions for entities, creating new art for SWC to use can all get you more CP's.

==Rewards==
There are many things you can exchange CPs for including:
*[http://www.swcombine.com/rules/?CP_Bonus_Ships CP Ships] - Ships with landing capacity must be spawned from inside a powered Starport or Landing Pad, whereas ships without landing capacity can only be purchased inside the following Space Stations: Trading I and Trading II, Shipyard I to IV, R&D I to IV.
*[http://www.swcombine.com/rules/?CP_Bonus_Vehicles CP Vehicles] - these must be spawned from inside a powered Garage, Hangar or Starport
*[http://www.swcombine.com/rules/?CP_Bonus_Droids CP Droids] - these must be spawned from inside a powered Tavern, Hangar, Shop, Commerce Center or Factory.
*Custom Items and [http://www.swcombine.com/rules/?NPCs#Custom_NPCs NPCs] (which exist solely for RP, and you can create your own [http://www.swcombine.com/rules/?Scripts script] for Custom NPCs)
*[[Custom_Images|Custom images]] for your entities, this is your chance to make your ship, speeder, item or anything else that you would like to look different to the norm, if you are no good at photoshopping there are multiple people in the game that you can hire for credits to create your customised paint job for you.
To exchange your points, find the [http://www.swcombine.com/members/cp/index.php?mode=exchange Exchange CPs] menu under the CP section on your sidebar in-game.

[[Category:OOC]]

Combine Points

2025-07-29T17:48:15Z

Ruben Wan: /* Activity */ changed amount of CPs in streak

Combine Points (or CPs) are an OOC reward to players for helping the combine. There are a variety of ways of obtaining them, as well as uses for them. The number you currently have is shown on the sidebar, underneath your avatar and can be exchanged for a variety of [[ships]], [[vehicles]], [[droids]] and various other things.

==Getting CPs==
CPs are obtained from supporting the Combine in some way. Most players will get them from being active, while others will get them for helping with art, or descriptions etc.

===Activity===
This is the main method with which players will gain CPs, once per 24 hours, just for logging in/playing the game. The system currently works based on a window, where you must access the website between 24-48 hours after a reward to receive the next one, rather than using the calendar day to define the boundaries. The goal here is to help people who may only be able to play the game briefly on certain days, where that activity window may also overlap with the end of a calendar day according to the server, which could result in missed rewards. Continued activity over the course of multiple days will result in larger bonuses, capping at the maximum bonus on the 7th day without failure and every day after.

You do not need to actually "log in" with your username+password; the normal activity checker for counting online players will trigger the check for you when you access the game in your browser.

{|
|'''Activity Streak''' || '''CPs'''
|-
|1 Day || 300
|-
|2 Days || 350
|-
|3 Days || 420
|-
|4 Days || 470
|-
|5 Days || 520
|-
|6 Days || 570
|-
|7+ Days || 620
|}

===Helping===
You can get CPs for helping enhance the Combine in many different ways. Helping to update descriptions for entities, creating new art for SWC to use can all get you more CP's.

==Rewards==
There are many things you can exchange CPs for including:
*[http://www.swcombine.com/rules/?CP_Bonus_Ships CP Ships] - these must be spawned from inside a powered Starport or Landing Pad.
*[http://www.swcombine.com/rules/?CP_Bonus_Vehicles CP Vehicles] - these must be spawned from inside a powered Garage, Hangar or Starport
*[http://www.swcombine.com/rules/?CP_Bonus_Droids CP Droids] - these must be spawned from inside a powered Tavern, Hangar, Shop, Commerce Center or Factory.
*Custom Items and [http://www.swcombine.com/rules/?NPCs#Custom_NPCs NPCs] (which exist solely for RP, and you can create your own [http://www.swcombine.com/rules/?Scripts script] for Custom NPCs)
*[[Custom_Images|Custom images]] for your entities, this is your chance to make your ship, speeder, item or anything else that you would like to look different to the norm, if you are no good at photoshopping there are multiple people in the game that you can hire for credits to create your customised paint job for you.
To exchange your points, find the [http://www.swcombine.com/members/cp/index.php?mode=exchange Exchange CPs] menu under the CP section on your sidebar in-game.

[[Category:OOC]]

Combine Points

2025-07-29T10:16:13Z

Ruben Wan: /* Rewards */

Combine Points (or CPs) are an OOC reward to players for helping the combine. There are a variety of ways of obtaining them, as well as uses for them. The number you currently have is shown on the sidebar, underneath your avatar and can be exchanged for a variety of [[ships]], [[vehicles]], [[droids]] and various other things.

==Getting CPs==
CPs are obtained from supporting the Combine in some way. Most players will get them from being active, while others will get them for helping with art, or descriptions etc.

===Activity===
This is the main method with which players will gain CPs, once per 24 hours, just for logging in/playing the game. The system currently works based on a window, where you must access the website between 24-48 hours after a reward to receive the next one, rather than using the calendar day to define the boundaries. The goal here is to help people who may only be able to play the game briefly on certain days, where that activity window may also overlap with the end of a calendar day according to the server, which could result in missed rewards. Continued activity over the course of multiple days will result in larger bonuses, capping at the maximum bonus on the 7th day without failure and every day after.

You do not need to actually "log in" with your username+password; the normal activity checker for counting online players will trigger the check for you when you access the game in your browser.

{|
|'''Activity Streak''' || '''CPs'''
|-
|1 Day || 150
|-
|2 Days || 175
|-
|3 Days || 210
|-
|4 Days || 235
|-
|5 Days || 260
|-
|6 Days || 285
|-
|7+ Days || 310
|}

===Helping===
You can get CPs for helping enhance the Combine in many different ways. Helping to update descriptions for entities, creating new art for SWC to use can all get you more CP's.

==Rewards==
There are many things you can exchange CPs for including:
*[http://www.swcombine.com/rules/?CP_Bonus_Ships CP Ships] - these must be spawned from inside a powered Starport or Landing Pad.
*[http://www.swcombine.com/rules/?CP_Bonus_Vehicles CP Vehicles] - these must be spawned from inside a powered Garage, Hangar or Starport
*[http://www.swcombine.com/rules/?CP_Bonus_Droids CP Droids] - these must be spawned from inside a powered Tavern, Hangar, Shop, Commerce Center or Factory.
*Custom Items and [http://www.swcombine.com/rules/?NPCs#Custom_NPCs NPCs] (which exist solely for RP, and you can create your own [http://www.swcombine.com/rules/?Scripts script] for Custom NPCs)
*[[Custom_Images|Custom images]] for your entities, this is your chance to make your ship, speeder, item or anything else that you would like to look different to the norm, if you are no good at photoshopping there are multiple people in the game that you can hire for credits to create your customised paint job for you.
To exchange your points, find the [http://www.swcombine.com/members/cp/index.php?mode=exchange Exchange CPs] menu under the CP section on your sidebar in-game.

[[Category:OOC]]

FAQ

2025-07-29T10:08:00Z

Ruben Wan: /* How can I support the Combine? */ removed accepting donations for running servers

==General Questions==

====What is the Star Wars Combine?====

The Star Wars Combine is an interactive online Star Wars simulation. People play the sim from diverse nations around the globe. The Star Wars Combine is 100% free of charge, and is a non-profit game.

In the Combine you will be allowed to create a character of your own with several different races to choose from. Upon character creation, you will have the option to join a group from a hefty list of candidates. Life in the Combine galaxy is just like stepping into George Lucas's epic Star Wars universe with the primary difference being that, in the Combine, there are none of the original Star Wars characters. No Luke Skywalker, no Leia Organa, no Mon Mothma, etc. However, the setting and general plot are the same, there is an ongoing war between the Galactic Empire and New Republic as well as plenty of other player-driven conflicts.

====What time period is the game set in? ====

Though it is difficult to assess the time in comparison to the movies (since events and people are different between the two), it has been generally agreed upon that this game is set within the area of Episode IV: A New Hope and Episode V: The Empire Strikes Back. However, with the new movies and new ideas, we will be incorporating ships and systems from them as well.

====What would make me choose to play this game? ====

The Star Wars Combine provides a unique gaming experience compared to other games in this modern era. Being that it is primarily a role playing (RP) game, much of the in-game history is written and dictated by the actions of our players. With just a few thousand active players, our community is relatively small but it provides ample opportunities for interaction and fun among players.

====What are CPs (Combine Points)? ====

The Combine Points are given to you by the admins for out of character (OOC) efforts you do to support and help the Star Wars Combine. Additionally, CPs are awarded each day that you log into SWC. You can exchange them for ships, vehicles and other inventory items (as they come available), some of which are only available through the CP exchange system.

====What does NPC mean?====

NPC = Non-Playing Characters. You can hire them to work for you, build ships, fight alongside you, etc.

====Can I kill another character? ====

Right now there are very few options to kill a character. A character can be executed, if they have had an arrest warrant issued on them and are currently under arrest. You can also kill yourself by flying into a sun, which also kills any other passengers located on that ship if the ship class is a Fighter, or Gunboat; For any other ship class, only the pilot is killed.

====Why are the prices of the ships higher than those shown in the rules area? ====

The prices shown in the rules area are the prices of production. The real prices depend on the traders and the in-game demand for ships.

====Can I have more than one character? ====

No, you are only allowed to have one character in the Combine. If your character dies you may create a new one after a period of time. Even if you leave your character for long periods of time, it is still best to try and log back in as that character or check with one of the administrators to see if your old character still exists before creating a new one.

====Can more than one player use the same computer? ====

Yes, but you must link the accounts via the Multi Self-Registration system. For more information check out https://www.swcombine.com/rules/?Character_Creation

====How can I remake my character? ====

Once a character is made in the Combine, it cannot be altered. The only ways a new character can be made is if your character dies or if you "drop" your character (you can find a link to "drop" your character by clicking the "Character" link on the side of the page). If stats are your concern, you are allowed a single re-roll prior to hitting level 3. Additionally, your skills may be upgraded as you progress in the game.

====Why must I wait a period of time to create a new character?====

This delay was set in order to keep Combine players from creating, killing, and then recreating characters in hopes of getting a Force-sensitive one.

====Who developed/is developing the Combine? ====

The current and former staff of Combine can be found on the Contacts page under the link "The SWC Team".

====Is the Combine affiliated with LucasArts/Disney?====

The Combine is an independent game created by a group of people that love Star Wars. They are not part of LucasArts/Disney.

====What are White Scenarios? ====

White scenarios are in-character (IC) role-playing scenarios that have members of the combine performing actions through the forums. GM's monitor the scenarios and perform actions with NPC's. In White Scenarios there are no repercussions for being involved. If you die in one, you will still be alive in the Combine. Depending on how well you role-play in the scenarios you will be given experience points (XPs). You can find scenarios through the community links RPG Centre under Portals.

====What Messaging System do most members use? ====

Most members use either the Combine messaging system (often referred to as "Darkness Message"), Discord, or SWC's IRC server. Currently, a directory of active Discord channels is maintained in the "General Talk" forum.

====What is IRC? ====

IRC is a instant messaging server. Some combine players use IRC as a primary form of communication to their factions.

====How do I register on IRC and what does it do? ====

Registering on IRC secures your user name to help make sure no one else can use it. To register you will need to type /msg NickServ REGISTER password e-mail (change e-mail and password to what you would like for them both [example /msg NickServ REGISTER 123456 example@hotmail.com) After this you’ll receive a conformation e-mail and every time you log in you will need to type in /msg NickServ IDENTIFY password

====What server do I go to on IRC? ====

irc.swc-irc.com

====How can I be in more than one IRC channel at once? ====

You will need to download an IRC chat client (e.g., mIRC from http://www.mirc.com ). Download and install this and you can be in as many channels as you want! It also has other handy features to make chatting easier.

====Can I also create a city?====

Anyone can create a city, yes. However, there are some requirements to construct a city. The terrain square you selected must be non-volcanic. Also, either you or your faction must posses the required amount of credits to build a city. It costs a minimum of 1,500,000 credits to build a city.

====I must travel to a system but I don't know where it is. ====

If you want to find out where a system, sector, planet or city you have to travel to is then you can look at the galaxy map. It is easy to navigate and can be found here: http://www.swcombine.com/rules/?Galaxy_Map

====How do I increase my skill points? ====

Every time you level, you receive a new skill point to use. These skill points can be allocated to your skills via the Character link on your right menu. However, such increases cannot be undone, and the definitions for skills which are not yet implemented may change in the future.

====How long does my character stay in combine if I am not active anymore? ====

Characters with XP Level 1 are wiped after 9 months of inactivity, all characters above Level 1 are retrievable at any time. Dead characters, however, can never be retrieved.

====This stat doesn't seem to do anything yet, why is it there? ====

Not all of the stats in the game have a use yet, but when the game is fully operational they will all have a use. You can view what your stats will be used for by reading through the various rules in the technical section.

====How much experience do I need to raise up my Experience Level?====

The needed experience is not the same for every level. To achieve level 2 you need 1000 experience, for level 3 - 3000. For level n you will need 1000 x (n-1) x n / 2. You can find a table with the experience points needed up to level 9 in the rules section.

====Can I create a new faction?====

Yes you can. To do so you will need to satisfy the conditions found on the Faction Creation rules.

==Technical Questions==

====What do I need to play the Combine in the terms of hardware, software, etc?====

A computer or smartphone capable of connecting to the Internet and a web browser.

====Do I have to download any software to play?====

No, all that you need is a browser.

==Rules Questions==

====Where can I find SWC's rules?====

You can find them and other information about the SWC at: https://www.swcombine.com/rules/

====What happens if I die?====

You lose all of your characters experience points, inventory and money. You will keep only your Combine Points and in three weeks you will be able to create a new character.

====Is theft allowed in the Combine? ====

Theft occurs in the Combine. How your character reacts or performs it is up to you.

====Why can I not change the details (like ownership) of a ship owned by a faction?====

You can only change a ship's information if you own it. Ships given by a faction for your use are a privilege, and being such are not owned by you. This action was implemented in order to prevent theft of a faction's property

====Is the Combine played in real time? ====

The Combine is played in delayed real time. For more information read https://www.swcombine.com/rules/?Timeframe

====What is spying and is it allowed?====

Spying is when you infiltrate a faction in order to gain information for another faction or person. Currently it is permitted under the rules. Full details on what you may and may not do in regards to spying can be found at http://www.swcombine.com/rules/?Spying .

====What are raw materials?====

Raw materials are the materials required to produce a certain piece of technology (ship, vehicle, weapon, etc.).

====How can I die?====

Currently, there are only a few ways to die: running a ship into a sun or black hole, aborting hyper travel and crashing into a celestial body, or getting your faction, or someone else, to execute you. Players may also "drop" their character to start a new one (the three week respawn timer still applies).

====How do I get raw materials?====

Raw materials can be mined or recovered via recycling. For mining, prospecting vehicles must be used to scan planets for deposits, and then a mining faction must construct a mine at the deposit location in order to mine the deposit for materials. For recycling, specific recycling entities must be used to break apart entities or wrecks into their basic materials.

==Getting Started Questions==

====Can I be a jedi?====

Every race has its own force probability, giving you a chance to be born force sensitive. But if you are not, then you can still become one later by gaining experience and levels.

====Why is the handle I selected declined?====

1: It has to sound like a word (Ex: "bgfive" or "imlame" would not be accepted, while "John doe" would be)

2: It can not be the name of an star wars character, although using the first or last names is allowed (Ex: "Luke skywalker is not a legal handle, but "Luke deacon" or "Mike skywalker" would be)

3: No titles in your handle are allowed (Ex: no "Sir" "Darth" "Princess" "Dr." etc...)

4: All handles must have a capital for the first letter of the name (Ex: "john doe" is not legit, but "John doe" is)

5: No special chars in it other then spaces, -, or ` (Ex: "John5 doe" would be illegal, but "John'ell doe" would work)

Each handle is unique; if it's too close to the name of another character it will be declined. (Ex: if you try to set your handle as "Jennifer Dreighton" it will automatically fail, since there already is a "Jennifer Dreighton"). You may have the same last name as another character, but you require their permission first. (Ex: There is a "Wilhelm von Ismay" and a "Victor von Ismay", but Wilhelm got Victor's permission before setting his last name to that).

====How do I log in? It keeps refreshing the page.====

First, use Lost Password to request a new password and log in with that. Be sure to paste or type it in exactly, as it is case sensitive.

If that fails, check to ensure that you are using the up to date version of your web browser. Clear your cache and make sure cookies are enabled.

If you are still having no luck, consider temporarily trying an alternate browser such as Opera (www.opera.com) or Mozilla (www.mozilla.org).

====How can I earn credits?====

1. You can join a faction that pays its members a salary and/or bonuses.

2. You can buy items and sell it for more.

3. You can collect CPs and exchange them for entities that can be sold for credits.

For more information, see the article on [[Credits]].

====How can I get a ship or vehicle? ====

In the beginning of your character's life, you will have the option of purchasing 3 ships for a very steep discount at the end of the tutorial, besides that, the easiest way of getting a ship or vehicle is by joining a faction and be assigned one. Later on when you have enough money you can buy another one for yourself. Another possibility is to exchange your CPs for some of the available ships and vehicles in the CP exchange.

====Which faction should I join?====

That depends on who you want your character to be - a rebel or an empire supporter, a bounty hunter, a trader, a pirate, a researcher, etc. If you want to fly an X-Wing or a Mon Calamari cruiser, then you should join the Rebel Alliance or one of its allies. If you prefer the Tie Fighters and the Star Destroyers then you should definitely join the Galactic Empire. Of course you can join any other faction as well, depending on your interests. And who says you have to join any at all?

====How do I get more Credits? ====

The easiest way is to join a faction and receive a salary. You can also exchange CPs for entities that can be sold for credits. Alternately, you can start your own business like transporting ships and passengers for credits. Another possibility is to get a loan from a Bank faction or from another player, if you find somebody willing to loan you money.

====How can I get off my starting planet?====

1. Make your way through the tutorial and purchase a ship.

2. Join a faction, most offer transport to the planet you'll be working on, or supply a ship to fly around in.

3. Buy a ride from another player or a transport faction, or rent a ship from another player/faction.

4. Save up CPs and exchange them for a ship.

5. Purchase a ship and have it moved to your location, to do this you'll need to earn some money first.

====How to change my location (travel)? ====

If you want to move from one position to another you have to go to position => travel => city => you can enter some coordinates. If you give coordinates from (0,0) to (21,21) when you are on foot (walking), you will travel only inside the city. If you want to go to another city, first move to the edge of your current city in the direction you would like to go. Then go to position => travel => cross terrain => then you can pick a position to where you want to go to.

====I just created my character and assigned skill points. Where do I go and what do I do?====

It's up to you. You can work alone and be a freelancer or you can join a faction. While being an independent freelancer may sound fun, it doesn't provide the benefits a faction does such as paychecks every month, a neat duty like piloting a ship or vehicle, and a place to call home. Visit http://www.swcombine.com/community/factions.php for more details on the various factions. If you are interested in a faction, it would not be a bad idea to check out that faction’s website, as well as contacting a member from the faction's recruiting office to get more information on that faction’s services and benefits.

==How to Questions==

====How can I gain CPs?====

The easiest way is to simply log in and play! You are awarded CPs every day that you log in. Suggesting planet descriptions, reporting bugs and typos, working on admin assignments or other ways of helping the development of the Combine can also be awarded.

====How can I improve my skills? ====

For every Experience Level you achieve, 1 skill point is added to your skill pool, which you can use to improve your skills, using the Character link on your right menu. However, skill increases cannot be undone, and it is possible that skill definitions for features not yet implemented may be changed in the future.

====How can I get more experience? ====

Experience points can be gained in many ways. Flying ships or piloting vehicles is a common method, it is also possible to gain them by mining or prospecting. Constructing buildings or stations gains an amount of experience. Small amounts are also awarded for certain achievements such as sending your first message or joining your first faction. Other ways may be added as the game develops.

====How can I send a message to another player? ====

Click on the Send message link in your menu (it looks like an envelope) then Send Message. Enter the handle of the recipient and enter the message itself.

====How can I send credits to another player? ====

Click on the display of your current credits total in the right hand menu. This should bring up the Transfer Credits screen. Enter the handle of the character or the name of the faction to receive the credits, then enter the amount and add a comment if you want. Finally click Transfer.

====How do I join a faction? ====

Click the Faction link on the right hand menu and then on Join Faction. Select the one you would want to join, add a message if you want, click submit and await further instructions. Generally allow up to 24-48 hours for a reply from the faction to see if you have been accepted or not.

====How do I launch a missile, fire my blaster or beat up a Wookiee? ====

Full-scale Player vs. Player (PvP) Combat is not yet implemented. It is possible to brawl with Brawler NPCs for experience points and factions have the ability to arrest and execute. Ground combat is currently in beta - there are a couple systems that allow PvP ground combat while Player vs. Environment (PvE) is implemented in every system - while space combat is in alpha - one may find space bandits hiding in asteroid fields in deep space.

====How do I report a bug? ====

If you encounter a bug, click on the "Report Bug" link at the bottom of the right side menu. Please browse though the list of bugs to make sure that the bug you are reporting is a new one. If you find that your bug is already listed, add a comment to it stating your problem as well.

====How can I support the Combine?====

There are many ways to support the Combine. You can join one of the many volunteer teams (Art, Descriptions, Development, QA) to help improve the game. You can report bugs and typos.

====How do I buy weapons/droids/items? ====

A few minor items can already be bought in Shop and Commerce Centre facilities. Shops can be found in most starting cities and are NPC-owned, while Commerce Centres are faction/player owned.

Otherwise, the majority of weapons, droids, and items can be purchased from the faction that produces them, which is displayed on the rules page for the item in question, or from players who already own them.

As an example, let's demonstrate a trade between two players. The person who buys the ship (Luke) has to contact the person who sells the ship (Han). Next, Luke has to pay for the ship by clicking on transaction sheet/credits transaction/transfer credits. Afterward, Luke must write the name of receiver, amount and communication and then choose the receiver type. When all this has been done, Luke solidifies the credit transfer by clicking on the "transfer" button. To give Luke his ship after receiving payment, Han has to click on "ships" in his personal inventory and choose who he wants to give the ship to (faction or person). Han must then select the ship Luke paid for and click on "Make Over."

Be warned that there are no guarantees for trading in the Combine and theft is an ever-present factor in the game.

====How do I enter a ship or vehicle?====

First, you have to be assigned to the crewlist or set as owner/commander/pilot of the ship or vehicle to be able to board it. Once that is taken care of, click on "Position", then "Enter". If the above parameters are met, you should be able to see the ship. Click "Board".

====How do I pilot a ship or vehicle? ====

After you have entered the ship or vehicle there will be a room map representing the layout of the entity in which you now reside. Find your way to the cockpit and a new button will appear on the side of the screen titled "Ship Controls" (or "Vehicle Controls"). Click that button and you will be taken to a new screen that will allow you to pilot your ship/vehicle.

====How do I travel in a ship?====

To move around within a ship, your status in the Control panel must be set to Position (as opposed to Cockpit -- see below).

To operate a ship, you first travel from the entrance room to the cockpit room. Once in the cockpit room, click "Ship Controls" (this option will only appear if you have been assigned as the pilot of the ship).

To lift off, hit the Travel button then Ascend. It takes an hour to reach (upper) atmosphere.

Once in the upper atmosphere, you need to reach orbit; this takes another hour. You do this from the Travel section by hitting Travel, then Orbit.

Once in orbit, you have to escape the gravity well of the planet you're orbiting; this is the section shaded in red on the display under Travel. Hit the Sublight button and click on some square that is not in the red. This should take roughly half an hour of travel.

Once out of the gravity well, you're free to go Hyper. Hit the Hyper button, then select from the menu of sectors (or choose a sector from the map of the galaxy), then select the desired system and Go.

NOTE: Don't try to abort once in Hyper. You can lose the ship and be killed that way, should you come out near a celestial body.

Upon entering a system, you'll be still a bit out from your destination planet; you'll have to hit Sublight and indicate which planet you want to go to.

Upon arrival at the planet, you're in orbit. You can, at that point, change over to any other ship also in orbit for which you are listed as a Crewmember. To do this, Travel to that room in the ship which has the exit, hit Board, and select from among ships to which you have entree.

To land a ship on the ground, you must reverse the lift-off procedure: First hit Travel, then Descend (and you can select your destination square on the planet); that takes an hour to put you in atmosphere. Once in atmosphere, you land by hitting Descend in the Travel section (and you can select your destination square in the city). Once landed, you can leave the ship by travelling to an exit room and hitting Board.

NOTE: Some planets are protected by shields and will require access to descend to the ground.

When you have been assigned as Pilot to a ship, you can then manage the crewlist. You do this with the Crewlist button on the bottom of the panel.

Summary:

Travel: Board
Control: Position: Travel to cockpit room
Control: Enter Cockpit

Travel: Ascend to atmosphere
Travel: Ascend to orbit
Travel: Sublight out of gravity well
Travel: Hyper to new system
Travel: Sublight to planet
Travel: Descend to atmosphere
Travel: Descend to ground

Control: Position: Travel to exit room
Travel: Board

FAQ

2025-07-29T10:07:03Z

Ruben Wan: /* How can I gain CPs? */ removed donating money for CPs

==General Questions==

====What is the Star Wars Combine?====

The Star Wars Combine is an interactive online Star Wars simulation. People play the sim from diverse nations around the globe. The Star Wars Combine is 100% free of charge, and is a non-profit game.

In the Combine you will be allowed to create a character of your own with several different races to choose from. Upon character creation, you will have the option to join a group from a hefty list of candidates. Life in the Combine galaxy is just like stepping into George Lucas's epic Star Wars universe with the primary difference being that, in the Combine, there are none of the original Star Wars characters. No Luke Skywalker, no Leia Organa, no Mon Mothma, etc. However, the setting and general plot are the same, there is an ongoing war between the Galactic Empire and New Republic as well as plenty of other player-driven conflicts.

====What time period is the game set in? ====

Though it is difficult to assess the time in comparison to the movies (since events and people are different between the two), it has been generally agreed upon that this game is set within the area of Episode IV: A New Hope and Episode V: The Empire Strikes Back. However, with the new movies and new ideas, we will be incorporating ships and systems from them as well.

====What would make me choose to play this game? ====

The Star Wars Combine provides a unique gaming experience compared to other games in this modern era. Being that it is primarily a role playing (RP) game, much of the in-game history is written and dictated by the actions of our players. With just a few thousand active players, our community is relatively small but it provides ample opportunities for interaction and fun among players.

====What are CPs (Combine Points)? ====

The Combine Points are given to you by the admins for out of character (OOC) efforts you do to support and help the Star Wars Combine. Additionally, CPs are awarded each day that you log into SWC. You can exchange them for ships, vehicles and other inventory items (as they come available), some of which are only available through the CP exchange system.

====What does NPC mean?====

NPC = Non-Playing Characters. You can hire them to work for you, build ships, fight alongside you, etc.

====Can I kill another character? ====

Right now there are very few options to kill a character. A character can be executed, if they have had an arrest warrant issued on them and are currently under arrest. You can also kill yourself by flying into a sun, which also kills any other passengers located on that ship if the ship class is a Fighter, or Gunboat; For any other ship class, only the pilot is killed.

====Why are the prices of the ships higher than those shown in the rules area? ====

The prices shown in the rules area are the prices of production. The real prices depend on the traders and the in-game demand for ships.

====Can I have more than one character? ====

No, you are only allowed to have one character in the Combine. If your character dies you may create a new one after a period of time. Even if you leave your character for long periods of time, it is still best to try and log back in as that character or check with one of the administrators to see if your old character still exists before creating a new one.

====Can more than one player use the same computer? ====

Yes, but you must link the accounts via the Multi Self-Registration system. For more information check out https://www.swcombine.com/rules/?Character_Creation

====How can I remake my character? ====

Once a character is made in the Combine, it cannot be altered. The only ways a new character can be made is if your character dies or if you "drop" your character (you can find a link to "drop" your character by clicking the "Character" link on the side of the page). If stats are your concern, you are allowed a single re-roll prior to hitting level 3. Additionally, your skills may be upgraded as you progress in the game.

====Why must I wait a period of time to create a new character?====

This delay was set in order to keep Combine players from creating, killing, and then recreating characters in hopes of getting a Force-sensitive one.

====Who developed/is developing the Combine? ====

The current and former staff of Combine can be found on the Contacts page under the link "The SWC Team".

====Is the Combine affiliated with LucasArts/Disney?====

The Combine is an independent game created by a group of people that love Star Wars. They are not part of LucasArts/Disney.

====What are White Scenarios? ====

White scenarios are in-character (IC) role-playing scenarios that have members of the combine performing actions through the forums. GM's monitor the scenarios and perform actions with NPC's. In White Scenarios there are no repercussions for being involved. If you die in one, you will still be alive in the Combine. Depending on how well you role-play in the scenarios you will be given experience points (XPs). You can find scenarios through the community links RPG Centre under Portals.

====What Messaging System do most members use? ====

Most members use either the Combine messaging system (often referred to as "Darkness Message"), Discord, or SWC's IRC server. Currently, a directory of active Discord channels is maintained in the "General Talk" forum.

====What is IRC? ====

IRC is a instant messaging server. Some combine players use IRC as a primary form of communication to their factions.

====How do I register on IRC and what does it do? ====

Registering on IRC secures your user name to help make sure no one else can use it. To register you will need to type /msg NickServ REGISTER password e-mail (change e-mail and password to what you would like for them both [example /msg NickServ REGISTER 123456 example@hotmail.com) After this you’ll receive a conformation e-mail and every time you log in you will need to type in /msg NickServ IDENTIFY password

====What server do I go to on IRC? ====

irc.swc-irc.com

====How can I be in more than one IRC channel at once? ====

You will need to download an IRC chat client (e.g., mIRC from http://www.mirc.com ). Download and install this and you can be in as many channels as you want! It also has other handy features to make chatting easier.

====Can I also create a city?====

Anyone can create a city, yes. However, there are some requirements to construct a city. The terrain square you selected must be non-volcanic. Also, either you or your faction must posses the required amount of credits to build a city. It costs a minimum of 1,500,000 credits to build a city.

====I must travel to a system but I don't know where it is. ====

If you want to find out where a system, sector, planet or city you have to travel to is then you can look at the galaxy map. It is easy to navigate and can be found here: http://www.swcombine.com/rules/?Galaxy_Map

====How do I increase my skill points? ====

Every time you level, you receive a new skill point to use. These skill points can be allocated to your skills via the Character link on your right menu. However, such increases cannot be undone, and the definitions for skills which are not yet implemented may change in the future.

====How long does my character stay in combine if I am not active anymore? ====

Characters with XP Level 1 are wiped after 9 months of inactivity, all characters above Level 1 are retrievable at any time. Dead characters, however, can never be retrieved.

====This stat doesn't seem to do anything yet, why is it there? ====

Not all of the stats in the game have a use yet, but when the game is fully operational they will all have a use. You can view what your stats will be used for by reading through the various rules in the technical section.

====How much experience do I need to raise up my Experience Level?====

The needed experience is not the same for every level. To achieve level 2 you need 1000 experience, for level 3 - 3000. For level n you will need 1000 x (n-1) x n / 2. You can find a table with the experience points needed up to level 9 in the rules section.

====Can I create a new faction?====

Yes you can. To do so you will need to satisfy the conditions found on the Faction Creation rules.

==Technical Questions==

====What do I need to play the Combine in the terms of hardware, software, etc?====

A computer or smartphone capable of connecting to the Internet and a web browser.

====Do I have to download any software to play?====

No, all that you need is a browser.

==Rules Questions==

====Where can I find SWC's rules?====

You can find them and other information about the SWC at: https://www.swcombine.com/rules/

====What happens if I die?====

You lose all of your characters experience points, inventory and money. You will keep only your Combine Points and in three weeks you will be able to create a new character.

====Is theft allowed in the Combine? ====

Theft occurs in the Combine. How your character reacts or performs it is up to you.

====Why can I not change the details (like ownership) of a ship owned by a faction?====

You can only change a ship's information if you own it. Ships given by a faction for your use are a privilege, and being such are not owned by you. This action was implemented in order to prevent theft of a faction's property

====Is the Combine played in real time? ====

The Combine is played in delayed real time. For more information read https://www.swcombine.com/rules/?Timeframe

====What is spying and is it allowed?====

Spying is when you infiltrate a faction in order to gain information for another faction or person. Currently it is permitted under the rules. Full details on what you may and may not do in regards to spying can be found at http://www.swcombine.com/rules/?Spying .

====What are raw materials?====

Raw materials are the materials required to produce a certain piece of technology (ship, vehicle, weapon, etc.).

====How can I die?====

Currently, there are only a few ways to die: running a ship into a sun or black hole, aborting hyper travel and crashing into a celestial body, or getting your faction, or someone else, to execute you. Players may also "drop" their character to start a new one (the three week respawn timer still applies).

====How do I get raw materials?====

Raw materials can be mined or recovered via recycling. For mining, prospecting vehicles must be used to scan planets for deposits, and then a mining faction must construct a mine at the deposit location in order to mine the deposit for materials. For recycling, specific recycling entities must be used to break apart entities or wrecks into their basic materials.

==Getting Started Questions==

====Can I be a jedi?====

Every race has its own force probability, giving you a chance to be born force sensitive. But if you are not, then you can still become one later by gaining experience and levels.

====Why is the handle I selected declined?====

1: It has to sound like a word (Ex: "bgfive" or "imlame" would not be accepted, while "John doe" would be)

2: It can not be the name of an star wars character, although using the first or last names is allowed (Ex: "Luke skywalker is not a legal handle, but "Luke deacon" or "Mike skywalker" would be)

3: No titles in your handle are allowed (Ex: no "Sir" "Darth" "Princess" "Dr." etc...)

4: All handles must have a capital for the first letter of the name (Ex: "john doe" is not legit, but "John doe" is)

5: No special chars in it other then spaces, -, or ` (Ex: "John5 doe" would be illegal, but "John'ell doe" would work)

Each handle is unique; if it's too close to the name of another character it will be declined. (Ex: if you try to set your handle as "Jennifer Dreighton" it will automatically fail, since there already is a "Jennifer Dreighton"). You may have the same last name as another character, but you require their permission first. (Ex: There is a "Wilhelm von Ismay" and a "Victor von Ismay", but Wilhelm got Victor's permission before setting his last name to that).

====How do I log in? It keeps refreshing the page.====

First, use Lost Password to request a new password and log in with that. Be sure to paste or type it in exactly, as it is case sensitive.

If that fails, check to ensure that you are using the up to date version of your web browser. Clear your cache and make sure cookies are enabled.

If you are still having no luck, consider temporarily trying an alternate browser such as Opera (www.opera.com) or Mozilla (www.mozilla.org).

====How can I earn credits?====

1. You can join a faction that pays its members a salary and/or bonuses.

2. You can buy items and sell it for more.

3. You can collect CPs and exchange them for entities that can be sold for credits.

For more information, see the article on [[Credits]].

====How can I get a ship or vehicle? ====

In the beginning of your character's life, you will have the option of purchasing 3 ships for a very steep discount at the end of the tutorial, besides that, the easiest way of getting a ship or vehicle is by joining a faction and be assigned one. Later on when you have enough money you can buy another one for yourself. Another possibility is to exchange your CPs for some of the available ships and vehicles in the CP exchange.

====Which faction should I join?====

That depends on who you want your character to be - a rebel or an empire supporter, a bounty hunter, a trader, a pirate, a researcher, etc. If you want to fly an X-Wing or a Mon Calamari cruiser, then you should join the Rebel Alliance or one of its allies. If you prefer the Tie Fighters and the Star Destroyers then you should definitely join the Galactic Empire. Of course you can join any other faction as well, depending on your interests. And who says you have to join any at all?

====How do I get more Credits? ====

The easiest way is to join a faction and receive a salary. You can also exchange CPs for entities that can be sold for credits. Alternately, you can start your own business like transporting ships and passengers for credits. Another possibility is to get a loan from a Bank faction or from another player, if you find somebody willing to loan you money.

====How can I get off my starting planet?====

1. Make your way through the tutorial and purchase a ship.

2. Join a faction, most offer transport to the planet you'll be working on, or supply a ship to fly around in.

3. Buy a ride from another player or a transport faction, or rent a ship from another player/faction.

4. Save up CPs and exchange them for a ship.

5. Purchase a ship and have it moved to your location, to do this you'll need to earn some money first.

====How to change my location (travel)? ====

If you want to move from one position to another you have to go to position => travel => city => you can enter some coordinates. If you give coordinates from (0,0) to (21,21) when you are on foot (walking), you will travel only inside the city. If you want to go to another city, first move to the edge of your current city in the direction you would like to go. Then go to position => travel => cross terrain => then you can pick a position to where you want to go to.

====I just created my character and assigned skill points. Where do I go and what do I do?====

It's up to you. You can work alone and be a freelancer or you can join a faction. While being an independent freelancer may sound fun, it doesn't provide the benefits a faction does such as paychecks every month, a neat duty like piloting a ship or vehicle, and a place to call home. Visit http://www.swcombine.com/community/factions.php for more details on the various factions. If you are interested in a faction, it would not be a bad idea to check out that faction’s website, as well as contacting a member from the faction's recruiting office to get more information on that faction’s services and benefits.

==How to Questions==

====How can I gain CPs?====

The easiest way is to simply log in and play! You are awarded CPs every day that you log in. Suggesting planet descriptions, reporting bugs and typos, working on admin assignments or other ways of helping the development of the Combine can also be awarded.

====How can I improve my skills? ====

For every Experience Level you achieve, 1 skill point is added to your skill pool, which you can use to improve your skills, using the Character link on your right menu. However, skill increases cannot be undone, and it is possible that skill definitions for features not yet implemented may be changed in the future.

====How can I get more experience? ====

Experience points can be gained in many ways. Flying ships or piloting vehicles is a common method, it is also possible to gain them by mining or prospecting. Constructing buildings or stations gains an amount of experience. Small amounts are also awarded for certain achievements such as sending your first message or joining your first faction. Other ways may be added as the game develops.

====How can I send a message to another player? ====

Click on the Send message link in your menu (it looks like an envelope) then Send Message. Enter the handle of the recipient and enter the message itself.

====How can I send credits to another player? ====

Click on the display of your current credits total in the right hand menu. This should bring up the Transfer Credits screen. Enter the handle of the character or the name of the faction to receive the credits, then enter the amount and add a comment if you want. Finally click Transfer.

====How do I join a faction? ====

Click the Faction link on the right hand menu and then on Join Faction. Select the one you would want to join, add a message if you want, click submit and await further instructions. Generally allow up to 24-48 hours for a reply from the faction to see if you have been accepted or not.

====How do I launch a missile, fire my blaster or beat up a Wookiee? ====

Full-scale Player vs. Player (PvP) Combat is not yet implemented. It is possible to brawl with Brawler NPCs for experience points and factions have the ability to arrest and execute. Ground combat is currently in beta - there are a couple systems that allow PvP ground combat while Player vs. Environment (PvE) is implemented in every system - while space combat is in alpha - one may find space bandits hiding in asteroid fields in deep space.

====How do I report a bug? ====

If you encounter a bug, click on the "Report Bug" link at the bottom of the right side menu. Please browse though the list of bugs to make sure that the bug you are reporting is a new one. If you find that your bug is already listed, add a comment to it stating your problem as well.

====How can I support the Combine?====

There are many ways to support the Combine. SWC accepts donations to offset the cost of running servers. You can join one of the many volunteer teams (Art, Descriptions, Development, QA) to help improve the game. You can report bugs and typos.

====How do I buy weapons/droids/items? ====

A few minor items can already be bought in Shop and Commerce Centre facilities. Shops can be found in most starting cities and are NPC-owned, while Commerce Centres are faction/player owned.

Otherwise, the majority of weapons, droids, and items can be purchased from the faction that produces them, which is displayed on the rules page for the item in question, or from players who already own them.

As an example, let's demonstrate a trade between two players. The person who buys the ship (Luke) has to contact the person who sells the ship (Han). Next, Luke has to pay for the ship by clicking on transaction sheet/credits transaction/transfer credits. Afterward, Luke must write the name of receiver, amount and communication and then choose the receiver type. When all this has been done, Luke solidifies the credit transfer by clicking on the "transfer" button. To give Luke his ship after receiving payment, Han has to click on "ships" in his personal inventory and choose who he wants to give the ship to (faction or person). Han must then select the ship Luke paid for and click on "Make Over."

Be warned that there are no guarantees for trading in the Combine and theft is an ever-present factor in the game.

====How do I enter a ship or vehicle?====

First, you have to be assigned to the crewlist or set as owner/commander/pilot of the ship or vehicle to be able to board it. Once that is taken care of, click on "Position", then "Enter". If the above parameters are met, you should be able to see the ship. Click "Board".

====How do I pilot a ship or vehicle? ====

After you have entered the ship or vehicle there will be a room map representing the layout of the entity in which you now reside. Find your way to the cockpit and a new button will appear on the side of the screen titled "Ship Controls" (or "Vehicle Controls"). Click that button and you will be taken to a new screen that will allow you to pilot your ship/vehicle.

====How do I travel in a ship?====

To move around within a ship, your status in the Control panel must be set to Position (as opposed to Cockpit -- see below).

To operate a ship, you first travel from the entrance room to the cockpit room. Once in the cockpit room, click "Ship Controls" (this option will only appear if you have been assigned as the pilot of the ship).

To lift off, hit the Travel button then Ascend. It takes an hour to reach (upper) atmosphere.

Once in the upper atmosphere, you need to reach orbit; this takes another hour. You do this from the Travel section by hitting Travel, then Orbit.

Once in orbit, you have to escape the gravity well of the planet you're orbiting; this is the section shaded in red on the display under Travel. Hit the Sublight button and click on some square that is not in the red. This should take roughly half an hour of travel.

Once out of the gravity well, you're free to go Hyper. Hit the Hyper button, then select from the menu of sectors (or choose a sector from the map of the galaxy), then select the desired system and Go.

NOTE: Don't try to abort once in Hyper. You can lose the ship and be killed that way, should you come out near a celestial body.

Upon entering a system, you'll be still a bit out from your destination planet; you'll have to hit Sublight and indicate which planet you want to go to.

Upon arrival at the planet, you're in orbit. You can, at that point, change over to any other ship also in orbit for which you are listed as a Crewmember. To do this, Travel to that room in the ship which has the exit, hit Board, and select from among ships to which you have entree.

To land a ship on the ground, you must reverse the lift-off procedure: First hit Travel, then Descend (and you can select your destination square on the planet); that takes an hour to put you in atmosphere. Once in atmosphere, you land by hitting Descend in the Travel section (and you can select your destination square in the city). Once landed, you can leave the ship by travelling to an exit room and hitting Board.

NOTE: Some planets are protected by shields and will require access to descend to the ground.

When you have been assigned as Pilot to a ship, you can then manage the crewlist. You do this with the Crewlist button on the bottom of the panel.

Summary:

Travel: Board
Control: Position: Travel to cockpit room
Control: Enter Cockpit

Travel: Ascend to atmosphere
Travel: Ascend to orbit
Travel: Sublight out of gravity well
Travel: Hyper to new system
Travel: Sublight to planet
Travel: Descend to atmosphere
Travel: Descend to ground

Control: Position: Travel to exit room
Travel: Board

XP

2019-02-02T12:08:38Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 30 XP with the following message: You hired an NPC for the first time.
*You gained 20 XP with the following message: You used an item for the first time.
*You gained 20 XP with the following message: You have joined chat for the first time.
*You gained 20 XP with the following message: You have made your first post on the forums. (SWC forums)
*You gained 40 XP with the following message: You learned how to build a facility.
*You gained 10 XP with the following message: You found out how to form a party.
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2019-01-11T12:04:07Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 20 XP with the following message: You used an item for the first time.
*You gained 20 XP with the following message: You have joined chat for the first time.
*You gained 20 XP with the following message: You have made your first post on the forums. (SWC forums)
*You gained 40 XP with the following message: You learned how to build a facility.
*You gained 10 XP with the following message: You found out how to form a party.
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

Trading

2018-12-26T01:03:17Z

Ruben Wan: /* Prices and Markets */

==How Does Trading Work? ==
===Trading===
'''Important things to keep in mind:''' 
In the Combine, stealing from players through trading is an acceptable In Character action and is, therefore, neither punished nor undone. As such, it is strongly advised that traders not send first to others they do not already trust. If you doubt the honesty of the other party, then use a respected middleman. If you aren't sure who to trust, the best thing to do is to consult established Trader Reputation lists or by asking someone in your faction. If you have IRC access, you may also consider asking around in the #SWC-Traders channel on irc.swc-irc.com (See IRC section below).

'''Known Scammers''' 
An up to date listing of known scammers, located in the Traders Lounge and compiled from the reports of traders posted in the forum.
http://www.swcombine.com/forum/thread.php?thread=9177&page=0

The idea behind trading is to buy and sell ships, vehicles, cities, buildings, and other assets in order to make a profit. At this time, most trading takes part in the IRC trading channel, in the Combine's RPG Centre forums, and on some private markets run by various factions. When visiting #SWC-Traders on IRC, you will see people using the following abbreviations:

'''WFS''' - What's for sale? 
This is asking the traders in the room what they are selling.

'''FS''' - For sale 
When you are trying to sell something, you would add FS as the start then the type of ships (e.g. FS: YT-1300, 2 Firesprays).

'''FT''' - For trade 
This means someone has a ship they wish to trade for another type of ship (e.g. FT: YT-510).

'''FA''' - For auction 
When something is for auction, normally the trader auctioning the item off will provide a link to the auction listing, or it will be online in another channel (e.g. FA: Carrack Cruiser - come to #my_room to bid).

'''OBO''' - Or Best Offer 
When the seller states a price he/she could also accept other offers (e.g. BFF-1 bulk freighter, 21 millions OBO).

'''WTB''' - Want to Buy 
When looking to buy a specific item, use this (e.g. WTB: Y-Wing).

'''WTS''' - Want to Sell 
When looking to sell a specific item, use this (e.g. WTS: X-Wing).

'''U/U/U''' - Undamaged, Undocked, Unshielded 
The entity is not under shield or inside another entity, and its stats are all topped.

When selling a ship, you may be asked to assign the ship first before making it over, and it is recommended that you ask the same of a seller if you are looking to buy a ship, if you have any doubts that they own it. Always avoid sending first to traders you do not trust, or are not listed as reputable. If the other party refuses to send first or to use a middleman, there is a high likelihood that they are trying to steal from you.

===Prices and Markets===

The Combine has an official market built into its interface, accessed through the '[[Galactic Market|Market]]' link on the right-hand menu (or through http://www.swcombine.com/members/market/ directly). To buy from or sell to the market, you must be on a trading station or inside a commerce centre facility. In case your faction cannot provide you access to such a facility, the factions Centrepoint Space Station and Baobab Merchant Fleet host a listing of public trading stations at http://www.centrepointstation.com/services/markets.php and http://bmf.force501.com/forum/viewtopic.php?f=104&t=2787 respectively. It is best to purchase items as close to your location as possible, since the closer you are to the item you are buying, the less it will cost you. When you purchase it from the market, it is made over to you immediately. Not many traders sell to this market as doing so is not very profitable, so the majority of assets available at any given time are usually the former possessions of a character that has recently died.

The Centrepoint Space Station trading faction also hosts a private market on its own website (referred to as Centrepoint Market, or CPM, and located at http://market.centrepointstation.com/), and this is what most traders use. This market can be compared to eBay, in that traders can post listings for items they are selling and other traders can bid on them or buy them out, but the items are not transferred immediately. The traders must contact each other to complete the transaction, and it is strongly recommended that a trusted middleman is used. This offsite market (linked in Useful Links below) is not officially affiliated with the Combine, and as such, any problems with it need to be directed to the faction hosting it.

The Trade Federation Market (aka TFM) is another place where individuals and companies can advertise their goods (http://dot.swc-tf.com/index.php).

The prices listed in the rules section of the Combine's website are only the raw production cost of each item. This is bound to be a much lower price than you will be able to purchase the items for from other players. Prices are constantly changing depending on how desirable the item in question is, how many are available to the public, and how much sellers are willing to sell for. Faction-specific items, such as TIE Fighters and A-Wings, are generally not available to the public. In the rare instance that some are successfully stolen from their faction, they tend to sell for hundreds of millions of credits.

===Useful Links===

'''Centrepoint Market '''
http://market.centrepointstation.com/

'''Trade Federation Market '''
http://dot.swc-tf.com/index.php

'''Traders Lounge''' ''(for trading discussion, not for buying/selling)''
http://www.swcombine.com/forum/forum.php?forumID=55

'''Commerce forum'''
http://www.swcombine.com/forum/forum.php?forumID=52

'''Gambling Hut '''
http://www.swcombine.com/forum/forum.php?forumID=139

===IRC (Internet Relay Chat)===

[[IRC]] refers to online chatrooms, used to communicate with other individuals in real-time over the Internet.

http://www.mirc.com
mIRC is the preferred client for the Windows platform. This is recommended for users who plan to use IRC on a regular basis.

http://www.swcombine.com/community/chat/
The Combine also hosts a Java client through which players can connect to the Combine IRC server directly through their web browser without downloading an alternate IRC client. This is recommended for users who will not be using IRC on a regular basis.

Server: irc.swc-irc.com
Port: 6667

'''Channels '''
* #swc-members - SWC Members Room, for general chat with other players.
* #swc-traders - SWC Trading Room, for buying and selling from other players.
* #swc-help - SWC Help Room, for Combine-related and IRC-related help.
* #CMG- is a prefix usually used to access a specific faction's chatroom.
[[Category:Advanced Activities]]
[[Category:Game Features]]

XP

2018-12-19T20:37:04Z

Ruben Wan:

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 20 XP with the following message: You have joined chat for the first time.
*You gained 20 XP with the following message: You have made your first post on the forums. (SWC forums)
*You gained 40 XP with the following message: You learned how to build a facility.
*You gained 10 XP with the following message: You found out how to form a party.
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

Medicine

2018-12-06T21:56:55Z

Ruben Wan: /* Medical Items: What and How */

== Medical Items: What and How ==

[http://www.swcombine.com/rules/?Medical_Items Medical items] will let you restore your own, another player's or an NPC's [[HP]].
They can be produced by any medical faction.

The following items are considered medical items and can be used to restore HP:

{| border="1" style="text-align:center;"
|-
| [[File:BactaPatch.png|center]][http://www.swcombine.com/rules/?Medical_Items&ID=107 Bacta Patch] || [[File:BactaRefill.png|center]][http://www.swcombine.com/rules/?Medical_Items&ID=114 Bacta Refill] || [[File:Emptybactatank.png|center]][http://www.swcombine.com/rules/?Medical_Items&ID=112 Bacta Tank] || [[File:HealingStick.png|center]][http://www.swcombine.com/rules/?Medical_Items&ID=111 Healing Stick] || [[File:KoltoPatch.png|center]][http://www.swcombine.com/rules/?Medical_Items&ID=399 Kolto Patch] || [[File:Medikit.png|center]] [http://www.swcombine.com/rules/?Medical_Items&ID=108 Medikit]
|}

To use a medical item, the following conditions must be met:

*You and your target need to be at the same location.
*You and your target must be in the same faction or be set as "Friend" on each other's IFF.
*You and your target must not be part of another medical action.
*For Bacta Tanks and Medikits: You need enough Bacta Refills inside the entity.
*For Bacta Tanks: The Tank must be deployed in a medical room and you and your target must be in the same room.

While being part of a medical action, neither you nor your target can move. Before being put into a Bacta Tank, the target automatically drops all equipped items.

=== Drugs ===

Trading factions may produce counterfeit medical items or drugs which look exactly like some medical items. These drugs are mainly made from Ryll and are cheaper to produce. However upon using them as a medical item, they result in 0 HP being recovered.

=== Using a Medical Item ===

To use a medical item on someone else, you have to apply it via the Item screen or - in case of the bacta tank - load the patient into the tank. After using a medical item, the following will happen to the medical item:
*Bacta Patch / Ryll Patch / Kolto Patch: item is destroyed
*Healing Stick / Death Stick: item is destroyed
*Medikit: Medikit remains, 1 Bacta Refill / Ryfill inside is destroyed
*Bacta Tank: Tank remains, all 3 Bacta Refills / Ryfills inside are destroyed

=== Filling a Bacta Tank ===
Bacta refills are loaded into the tank the same way one would load items into a container.
*Click on a bacta refill.
*The tank is now highlighted as a location where the item can be moved into.
*Click on the tank.
*Repeat the above two more times, until you have 3 refills in the tank.

== Equations ==
{| Border="1" style="text-align:center;"
|-
| '''Item''' || '''Base Amount Healed''' || '''Refills Needed''' || '''Time/min'''
|-
| Kolto Patch || 3 || N/A || 30
|-
| Bacta Patch || 5 || N/A || 30
|-
| Healing Stick || 8 || N/A || 30
|-
| Medikit with Bacta Refill || 10 || 1 || 30
|-
| Bacta Tank with Bacta Refill || All HP Restored|| 3 || 600&dagger;
|-
| Ryll Patch || 0 || N/A || 30
|-
| Death Stick || 0 || N/A || 30
|-
| Medikit with Bacta Ryfill || 0 || 1 || 30
|-
| Bacta Tank with Bacta Ryfill || 0 || 3 || 600&dagger;
|}
&dagger;NOTE: For most medical items, both the player using the item (the "healer") and the player being healed will enter into a Medical Timer. However, for Bacta Tanks, only the player being healed receives a timer, leaving the "healer" free to go about other activities.

The amount of HP restored depends on the item used and the user's Medical Skill as per the following formula:

HP restored = round(Base Amount Healed × (Medical Skill + 1))

If the healing is done within a [[#Entities with Medical Rooms|medical entity]], the healing power of the medical items is increased by a factor of 1.3:

HP restored = round(Base Amount Healed × (Medical Skill + 1) × 1.3)

The XP gained from using medical items is:

XP gained = round(HP restored / 2)

=== Example 1 ===

Veynom has 12 HP left of his maximum of 85 HP. He has a Medical Skill of 3. He applies a Bacta Patch to heal his wounds.

HP restored = 5 * (3 + 1) = 20
XP gained = 20 / 2 = 10

=== Example 2 ===

Selatos has 20 HP left of his maximum 100 HP. He has a Medical Skill of 5. He uses a Medikit with a Bacta Refill to heal his wounds.

HP restored = 10 * (5 + 1) = 60
XP gained = 60 / 2 = 30

=== Bacta Tanks ===

Bacta Tanks can only be deployed in medical rooms. For a bacta tank to be deployed, it must be inside a medical room and no other tanks can be deployed in the same room. (i.e., you can only deploy a single tank in a room).

Once deployed, the tank can be loaded with up to three Bacta Refills. Once a single refill is loaded, the tank cannot be undeployed, nor can the refill be taken out again. You cannot load more than three refills.

Once three refills have been loaded, you can apply the tank to a patient (either yourself, another player or an NPC in your party). At that time, the patient will drop all items he's carrying and is loaded into the tank. He will be ejected once the healing process is completed.

Any player can add an unconscious player to their party, and a Bacta Tank can be used to heal them above 0 HP.

Bacta Tanks can be flushed, removing any previously loaded Bacta Refills (or Bacta Ryfills) in the process. This can only be done if no patient is present in the tank.

== Entities with Medical Rooms ==

The following entities contain one or more medical rooms.

*Facilities:
Asylum (1), Command Centre (1), Conference Centre (1), Government House (1), Hospital (6), Imperial Palace (2), Palace (1), Praxium (1), Royal Hapan Palace (1), Sith Temple (1)

*Ships:
Ardent-class Fast Frigate (1), Battle Dragon (1), Darkstar-class Battleship (1), EF65 Meridian-class Frigate (2), EF76 Nebulon-B Medical Frigate (4), Executor-class Star Destroyer (1), Imperial I-class Star Destroyer (1), Ithorian Herdship (1), Lucrehulk-class Battleship (1), MC-80 Home One-class Star Cruiser (1), MC-80a Star Cruiser (1), MC-80b Star Cruiser (1), Prometheus-class Star Craft (2), Pulsar Battle Cruiser (1), Sprint-class Rescue Craft (2), Veltraa-class Cruiser (1), Verpine-class Heavy Cruiser (1)

*Vehicles:
Conquest-class Carrier (1), Kettrifee Air Mover (4)

*Space Stations:
Centrepoint Station (1), Jubilee Wheel (4), Hospital Platform XQ-2 (3), Medical Factory Station (1)
[[Category:Advanced Activities]]
[[Category:Game Features]]

XP

2018-11-29T18:55:49Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 20 XP with the following message: You have made your first post on the forums. (SWC forums)
*You gained 40 XP with the following message: You learned how to build a facility.
*You gained 10 XP with the following message: You found out how to form a party.
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-26T19:02:58Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 40 XP with the following message: You learned how to build a facility.
*You gained 10 XP with the following message: You found out how to form a party.
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-24T02:07:49Z

Ruben Wan:

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 10 XP with the following message: You found out how to form a party.
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-24T00:12:32Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 40 XP with the following message: You now know how to use scanners.
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-17T18:10:02Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 10 XP with the following message: You walked to another room for the first time.
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-17T15:57:26Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 40 XP with the following message: You made your first hyperspace jump.
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-16T20:32:23Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 20 XP with the following message: You learned how to use the transactions system. (send credits)
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown. (travel sublight)
*You gained 20 XP with the following message: You found out how to assign assets. (assign something)
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-16T00:05:59Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 40 XP with the following message: You have left your homeworld for horizons unknown.
*You gained 20 XP with the following message: You found out how to assign assets.
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-15T23:30:32Z

Ruben Wan: /* Crafting */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10 XPs when you successfully complete crafting an item.

===First Time XP===
*You gained 20 XP with the following message: You found out how to assign assets.
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

XP

2018-11-15T23:30:10Z

Ruben Wan: /* First Time XP */

XP refers to your Experience Points. These are a measure of how much experience you have accumulated as your character, and generally how powerful you are. The more XP you have, the higher your level, and the more skill points you have available to allocate to your skills.

==Getting XP==
There are a variety of different ways of getting XP. It is received for the majority of in-game actions within the SWC interface. Some of the ways to accumulate XP are listed below:

===Building===

===Crafting===
[[Crafting]] nets you 10XP when you sucessfully complete crafting an item.

===First Time XP===
*You gained 20 XP with the following message: You found out how to assign assets.
*You gained 50 XP with the following message: You sent a DM to your faction.
*You gained 100 XP with the following message: You used NPC Transport Service for the first time.
*You gained 50 XP with the following message: You successfully found your way out of the starting building.
*You gained 100 XP with the following message: You are now a faction member for the first time.
*You gained 20 XP with the following message: You started using the message system.
*You gained 20 XP with the following message: You sent your first faction join request

===Force Training===
Those who are able to use the force gain experience every time they successfully train. As well as gaining experience towards their next level of force mastery, a character also gains 15 XP for every successful training session.

If training with an apprentice, should the apprentice successfully train then the apprentice gains 15 XP and the master gains 5 XP for overseeing them.

===Healing===
You receive XP each time you heal yourself from an injury and gain XP equal to half the amount of HP healed. The amount healed improves with your Medical Treatment skill and with the quality of medical items used. A bacta tank or medikit loaded with bacta refills heals for the greatest amount of HP, and therefore rewards you with the most XP (although a bacta tank takes a long time to complete healing and is an inefficient source of XP gain). Healing sticks provide the next highest amount of healing, followed by bacta patches.

Using a healing item while on board a medical entity, which is any entity containing at least one healing room, multiplies the amount of healing done by 1.3, and therefore also provides you with more XP.

===Hunting===
Hunting is one of the most lucrative means of XP gain. You receive up to 40 XP per half hour combat round and cannot die. XP is decreased if you miss any shots. See the [[Hunting]] page for more information and for detailed advice about getting started and maximizing your XP gains.

===Making Doors===
[[Doors and Locks|Installing doors]] gives you a varying amount of XP, depending on the level of the door you are installing:

{|
|-
| '''Level''' || '''XP'''
|-
| 1 || 20XP
|-
| 2 || 40XP
|-
| 3 || 80XP
|}

===Mining===
[[Production (Mining)|Mining]] nets you a set 10XP each time a mine finishes mining. This happens after the 7 day mining period ends. If the mine is set to 'repeat' then it will continue to mine, giving you 10XP every week until it stops.

===Production===

===Recycling===

===Travel===
Ground travel enables you to gain 1 XP per surface square traveled, and crossing terrain enables you to gain 10 XP. Space travel enables you to gain 1 XP per coordinate traveled, both in sublight and in hyperspace. Traveling between ground and atmosphere in a ship, or atmosphere and orbit, enables you to gain 5 XP for that trip.

===Scenarios===
Participating in [[White Scenarios]] rewards you with up to 150 XP per post, based on the quality and quantity of your roleplaying post content. The average per post is around 40 XP.

Participating in the Scenario Hall forum in the RPG Centre rewards you with up to 20 XP per post, also based on quality and quantity of your post content. These are easier to join than a White Scenario and require considerably less time for the moderators to complete scoring, so you receive XP more quickly.

There is no limit to the number of scenarios you can participate in simultaneously on either board.

[[Category:Features]]

Construction

2018-10-07T07:42:26Z

Ruben Wan: /* Construction Process */

Construction is a term used to categorise the creation of cities, facilities and stations and can be considered separate from [[production]]. This article attempts to cover the construction of such entities in brief.

Facilities can be either built on the ground or in space, with each having a different set of requirements and restrictions. They will therefore be discussed individually.

==Space Stations==
[[File:Golan2.jpg|Golan II Defence Station]]

Space stations are large structures built only within systems. These can serve a variety of uses, some act as defensive structures such as Golan class (see above), designed to attack enemies nearby. Others can be used for trading, production or [[recycling]].

===Requirements===
Before construction can commence on a station, various things must be gathered before the user can proceed.

*Station Blueprints - The user must get hold of blueprints for the station they wish to build. Station blueprints are distributed primarily to factions, with different factions holding station blueprints. Government factions have the widest range of stations, holding many of the defensive and support station designs, while Smugglers and mercenary groups have facilities such as Asteroid Hideouts. The user may be able to join one of these factions in order to make use of the plans.
*Raw Materials - The user will need raw materials in order to construct their station. These must be located on a [[Ships|ship]] at the site of the project. Be aware that large stations such as Golan II or Shipyard IV will require dramatically more resources to build. Also the user will need credits.
*[[NPC]]s - Builder NPCs are required to construct stations. These need to be at the same system location as the planned station. A user may have anywhere between one and 25 NPCs working on a station.
* [[Privileges]] - If the user is building the station for a faction then they require the relevant materials privileges to use faction resources and the relevant construction privileges.
* The area of space the user wishes to build in must not contain another station, star or black hole.
* Build Permissions - Users may build a station in orbit of a planet however in order to do so, the request must be approved by the sector owner. Before construction can commence, a build request must be submitted to the owning faction stating the precise nature of the project for the factions consideration. If approved then you may build only the requested facility.

===Construction Process===

Once the above has been considered, the user is ready to build. Proceed to the entrance room of the ship to find the option for Station Construction. The preview will show the intended location of the station and a time estimate will be provided. The user may then assign any number of builder NPCs to the project, with more builders decreasing the time taken. Additionally the users management skill will reduce the financial cost and time requirements.

Once accepted the project will commence. The station foundations are placed in the system and will be noticeable effective immediatly. All raw materials and NPCs involved in the project transfer onto the station, at which point the user is free to move along and come back at a later date. Note that stations will take a long time to produce, some can take several months to build. Once completed, an amount of experience is provided to the user as well as all NPCs.

===Pausing/Aborting Construction===

Once a construction project has started it can be halted through the stations management section. The project will then be stopped. A project can remain halted indefinitely without problem.

Alternatively the project can be cancelled remotely by anyone with sufficient privileges to do so or the original builder. When the project is cancelled there is the option to return any used resources to any ship at the same location. The amount of resources returned is equal to the percentage of the project remaining minus 10%. It will also take a few hours to take the station apart, the closer it is to completion the longer it will take to dismantle.

All NPCs will finally leave the station remains once completely dismantled and can be collected in a specialist escape pod.

==Ground Facilities==
Ground facilities are structures based on a planets surface and are built in mostly the same way to stations also having similar requirements and limitations.

===City Placement===
A user cannot start construction on a planet straight away. First any space on the ground which needs construction must be developed into a city. The person must descend to the planets surface to perform what is known as "slabbing". This converts the empty surface tile into a city ready for construction.

The process costs an amount of credits between one and three million credits depending upon the terrain type being used and will take an hour. It may also cost an extra half million if the planet is of a particularly dangerous atmosphere. This cost can be paid by either the individual or, if built for faction purposes, faction credits. The user does not need any NPC for this task.

Alternatively the user may opt to make the city a hidden city. Hidden cities do not appear on planetary maps and are not visible from above unless a character is in the atmosphere directly above.

Caution, if the city is empty for more than three months the city will be removed and the slabbing costs will not be returned.

===Facility Construction Requirements===

Once a city has been founded, the user is able to construct facilities. Before building though, it is adviseable to use the [http://www.swcombine.com/citydesigner/| Combine City Designer]. This will allow the user to plan out their city and identify if their design is valid, whether it will have sufficient power etc. The designer will also show the amount of materials required.

Before a user can construct there are requirements, many of these the same as space stations such as the need for facility blueprints. Again various faction types have the ability to create such buildings. Otherwise the user still needs raw materials, credits, NPC builders as well as permissions from the city owner to build.

Additional concerns:
* Validity - A facility has slightly different requirements in that it MUST have two completely free sides to build roads along them. Note that the edges of the city do not count as free space.
* Power - Once completed, a facility will require power to function. This can be provided from any Power Generators in the same city. Without power it cannot perform the majority of its functions.

===Construction Process===
The resources to commence construction must be available in any ship or pre-existing facility in the city. Once again faction privileges are required to use faction resources.

The user must have builder NPCs in their party and must enter the city. In order to start construction, the user must stand in a square adjacent to the planned facility.

The user may then name the facility, select a type of facility and the ownership of the finished object. Note that some items MUST be owned by a faction, such as religious or defensive facilities. The user may select the orientation of the finished city, either horizontally or vertically.

The next step will be to see how the city will appear with the finished building, which is demonstrated on the preview. The design may also be changed by the user to suit the planets environment or design, finally the number of builders can be assigned to the project. The maximum number of builders which can be assigned is 10, with more reducing the time slightly as well as the Management skill. It is possible to start construction with a number of Builders and later add more Builders (within the maximum 10 NPCs per facility limit). NPCs are added through the Party command menu.

Once the project has been started the user is free to move somewhere else and allow the NPC to work. Once completed the builder and manager will receive experience points.

===Pausing/Aborting Construction===
Construction work can be halted on a project by removing NPCs from the project. Most commonly this happens when an NPC is arrested. If the number of active NPCs reaches zero, production stops. NPCs can then be re added if necessary. Construction can also be halted through facility management options.

Additionally it is possible to abort the production, materials may be returned to any ship, vehicle or suitable facility. As per before, resources returned equals the percentage left on the project minus 10 percent.
[[Category:Advanced Activities]]
[[Category:Game Features]]

Construction

2018-10-07T07:32:02Z

Ruben Wan: /* Construction Process */

Construction is a term used to categorise the creation of cities, facilities and stations and can be considered separate from [[production]]. This article attempts to cover the construction of such entities in brief.

Facilities can be either built on the ground or in space, with each having a different set of requirements and restrictions. They will therefore be discussed individually.

==Space Stations==
[[File:Golan2.jpg|Golan II Defence Station]]

Space stations are large structures built only within systems. These can serve a variety of uses, some act as defensive structures such as Golan class (see above), designed to attack enemies nearby. Others can be used for trading, production or [[recycling]].

===Requirements===
Before construction can commence on a station, various things must be gathered before the user can proceed.

*Station Blueprints - The user must get hold of blueprints for the station they wish to build. Station blueprints are distributed primarily to factions, with different factions holding station blueprints. Government factions have the widest range of stations, holding many of the defensive and support station designs, while Smugglers and mercenary groups have facilities such as Asteroid Hideouts. The user may be able to join one of these factions in order to make use of the plans.
*Raw Materials - The user will need raw materials in order to construct their station. These must be located on a [[Ships|ship]] at the site of the project. Be aware that large stations such as Golan II or Shipyard IV will require dramatically more resources to build. Also the user will need credits.
*[[NPC]]s - Builder NPCs are required to construct stations. These need to be at the same system location as the planned station. A user may have anywhere between one and 25 NPCs working on a station.
* [[Privileges]] - If the user is building the station for a faction then they require the relevant materials privileges to use faction resources and the relevant construction privileges.
* The area of space the user wishes to build in must not contain another station, star or black hole.
* Build Permissions - Users may build a station in orbit of a planet however in order to do so, the request must be approved by the sector owner. Before construction can commence, a build request must be submitted to the owning faction stating the precise nature of the project for the factions consideration. If approved then you may build only the requested facility.

===Construction Process===

Once the above has been considered, the user is ready to build. Proceed to the entrance room of the ship to find the option for Station Construction. The preview will show the intended location of the station and a time estimate will be provided. The user may then assign any number of builder NPCs to the project, with more builders decreasing the time taken. Additionally the users management skill will reduce the financial cost and time requirements.

Once accepted the project will commence. The station foundations are placed in the system and will be noticeable effective immediatly. All raw materials and NPCs involved in the project transfer onto the station, at which point the user is free to move along and come back at a later date. Note that stations will take a long time to produce, some can take several months to build. Once completed, an amount of experience is provided to the user as well as all NPCs.

===Pausing/Aborting Construction===

Once a construction project has started it can be halted through the stations management section. The project will then be stopped. A project can remain halted indefinitely without problem.

Alternatively the project can be cancelled remotely by anyone with sufficient privileges to do so or the original builder. When the project is cancelled there is the option to return any used resources to any ship at the same location. The amount of resources returned is equal to the percentage of the project remaining minus 10%. It will also take a few hours to take the station apart, the closer it is to completion the longer it will take to dismantle.

All NPCs will finally leave the station remains once completely dismantled and can be collected in a specialist escape pod.

==Ground Facilities==
Ground facilities are structures based on a planets surface and are built in mostly the same way to stations also having similar requirements and limitations.

===City Placement===
A user cannot start construction on a planet straight away. First any space on the ground which needs construction must be developed into a city. The person must descend to the planets surface to perform what is known as "slabbing". This converts the empty surface tile into a city ready for construction.

The process costs an amount of credits between one and three million credits depending upon the terrain type being used and will take an hour. It may also cost an extra half million if the planet is of a particularly dangerous atmosphere. This cost can be paid by either the individual or, if built for faction purposes, faction credits. The user does not need any NPC for this task.

Alternatively the user may opt to make the city a hidden city. Hidden cities do not appear on planetary maps and are not visible from above unless a character is in the atmosphere directly above.

Caution, if the city is empty for more than three months the city will be removed and the slabbing costs will not be returned.

===Facility Construction Requirements===

Once a city has been founded, the user is able to construct facilities. Before building though, it is adviseable to use the [http://www.swcombine.com/citydesigner/| Combine City Designer]. This will allow the user to plan out their city and identify if their design is valid, whether it will have sufficient power etc. The designer will also show the amount of materials required.

Before a user can construct there are requirements, many of these the same as space stations such as the need for facility blueprints. Again various faction types have the ability to create such buildings. Otherwise the user still needs raw materials, credits, NPC builders as well as permissions from the city owner to build.

Additional concerns:
* Validity - A facility has slightly different requirements in that it MUST have two completely free sides to build roads along them. Note that the edges of the city do not count as free space.
* Power - Once completed, a facility will require power to function. This can be provided from any Power Generators in the same city. Without power it cannot perform the majority of its functions.

===Construction Process===
The resources to commence construction must be available in any ship or pre-existing facility in the city. Once again faction privileges are required to use faction resources.

The user must have builder NPCs in their party and must enter the city. In order to start construction, the user must stand in a square adjacent to the planned facility.

The user may then name the facility, select a type of facility and the ownership of the finished object. Note that some items MUST be owned by a faction, such as religious or defensive facilities. The user may select the orientation of the finished city, either horizontally or vertically.

The next step will be to see how the city will appear with the finished building, which is demonstrated on the preview. The design may also be changed by the user to suit the planets environment or design, finally the number of builders can be assigned to the project. The maximum number of builders which can be assigned is 10, with more reducing the time slightly as well as the Management skill. It is possible to start construction with a number of Builders and later add more Builders (within the maximum 10 NPCs per facility limit).

Once the project has been started the user is free to move somewhere else and allow the NPC to work. Once completed the builder and manager will receive experience points.

===Pausing/Aborting Construction===
Construction work can be halted on a project by removing NPCs from the project. Most commonly this happens when an NPC is arrested. If the number of active NPCs reaches zero, production stops. NPCs can then be re added if necessary. Construction can also be halted through facility management options.

Additionally it is possible to abort the production, materials may be returned to any ship, vehicle or suitable facility. As per before, resources returned equals the percentage left on the project minus 10 percent.
[[Category:Advanced Activities]]
[[Category:Game Features]]

SWC LISP

2018-09-15T22:10:44Z

Ruben Wan: /* Lists */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|floor || || || || ||
|-
|ceil || || || || ||
|-
|round || || || || ||
|-
|log || || || || ||
|-
|exp || || || || ||
|-
|modulo || || || || ||
|-
|stochastic_round || || || || ||
|-
|list-of-zeros ||number||Makes a list of ''number'' 0s|| || ||(load "mathematics")
|-
|toDigits ||number base||Convert a positive whole ''number'' to its digit representation in ''base''. If you pass a floating point ''number'', it will be rounded down || || ||(load "mathematics")
|-
|digits-to-base ||list baselist ||Takes a ''list'' of digits and converts them to a base representation as provided in ''baselist'' || || ||(load "mathematics")
|-
|fromDigits ||digits base||List of ''digits'' in base ''base'' and converts to decimal || || ||(load "mathematics")
|-
|add-leading-digits ||digits n-digits ||Takes a list of ''digits'' and normalises it to N-digits. Less than N-digits adds leading zeros || || ||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
| make-seq ||number (function n) ||Creates a list of integer ''number''+1 terms using the passed ''function'' of the termid. Function must take one integer as a parameter ||1. (make-seq 3 (lambda (n) (+ n 1))) 2. (make-seq 2 (lambda (n) 1)) ||1. '(4 3 2 1) 2. '(1 1 1) || (load "funlib")
|-
| find-matches-in ||val searchlist (matchfun?) || || || || (load "funlib")
|-| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| find-pos-of-matches-in ||val searchlist (counter) (matchfun?) || || || || (load "funlib")
|-
| drop-first-n ||num list ||Removes first ''num'' elements of ''list'' || || || (load "funlib")
|-
| remove-duplicates ||list ||Removes duplicates from one-dimensional list of atmos ''list'' || || || (load "funlib")
|-
| set-nth ||list nth val ||Returns ''list'' with the ''nth'' element replaced with ''val'' || || || (load "funlib")
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
| has-room-in-party || || || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(say "Hello World!") ||"Hello World!" ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(describe "The droid beeps and burps.") ||''The droid beeps and burps.'' ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(ooc "Now go to the mentioned location and talk to the NPC there.") || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.||(add-response "Wow, I didn't know that!" explainmore) ||say "Wow, I didn't know that!" ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. ||(add-action " exit the room." room12) ||''You exit the room.'' ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

SWC LISP

2018-09-15T20:27:09Z

Ruben Wan: /* Arithmetic Operators */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|floor || || || || ||
|-
|ceil || || || || ||
|-
|round || || || || ||
|-
|log || || || || ||
|-
|exp || || || || ||
|-
|modulo || || || || ||
|-
|stochastic_round || || || || ||
|-
|list-of-zeros ||number||Makes a list of ''number'' 0s|| || ||(load "mathematics")
|-
|toDigits ||number base||Convert a positive whole ''number'' to its digit representation in ''base''. If you pass a floating point ''number'', it will be rounded down || || ||(load "mathematics")
|-
|digits-to-base ||list baselist ||Takes a ''list'' of digits and converts them to a base representation as provided in ''baselist'' || || ||(load "mathematics")
|-
|fromDigits ||digits base||List of ''digits'' in base ''base'' and converts to decimal || || ||(load "mathematics")
|-
|add-leading-digits ||digits n-digits ||Takes a list of ''digits'' and normalises it to N-digits. Less than N-digits adds leading zeros || || ||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
| has-room-in-party || || || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(say "Hello World!") ||"Hello World!" ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(describe "The droid beeps and burps.") ||''The droid beeps and burps.'' ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(ooc "Now go to the mentioned location and talk to the NPC there.") || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.||(add-response "Wow, I didn't know that!" explainmore) ||say "Wow, I didn't know that!" ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. ||(add-action " exit the room." room12) ||''You exit the room.'' ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

SWC LISP

2018-09-15T19:40:44Z

Ruben Wan: /* Others */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|floor || || || || ||
|-
|ceil || || || || ||
|-
|round || || || || ||
|-
|log || || || || ||
|-
|exp || || || || ||
|-
|modulo || || || || ||
|-
|stochastic_round || || || || ||
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
| has-room-in-party || || || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(say "Hello World!") ||"Hello World!" ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(describe "The droid beeps and burps.") ||''The droid beeps and burps.'' ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(ooc "Now go to the mentioned location and talk to the NPC there.") || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.||(add-response "Wow, I didn't know that!" explainmore) ||say "Wow, I didn't know that!" ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. ||(add-action " exit the room." room12) ||''You exit the room.'' ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

Talk:SWC LISP

2018-09-15T18:51:21Z

Ruben Wan:

same-time? and cmp-time do the same thing and are in the same library.

rand-from-list Y16D1 and rand-from-list-unique are two different functions or the same?

sublist-firstof or sublists-firstof?

on Y18D5 get-entity alone is not present, there are several get-entity-somethingMore. Is it ok or is it missing?

Talk:SWC LISP

2018-09-15T18:47:50Z

Ruben Wan:

same-time? and cmp-time do the same thing and are in the same library.

rand-from-list Y16D1 and rand-from-list-unique are two different functions or the same?

sublist-firstof or sublists-firstof?

SWC LISP

2018-09-15T18:42:24Z

Ruben Wan: /* Arithmetic Operators */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|floor || || || || ||
|-
|ceil || || || || ||
|-
|round || || || || ||
|-
|log || || || || ||
|-
|exp || || || || ||
|-
|modulo || || || || ||
|-
|stochastic_round || || || || ||
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(say "Hello World!") ||"Hello World!" ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(describe "The droid beeps and burps.") ||''The droid beeps and burps.'' ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(ooc "Now go to the mentioned location and talk to the NPC there.") || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.||(add-response "Wow, I didn't know that!" explainmore) ||say "Wow, I didn't know that!" ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. ||(add-action " exit the room." room12) ||''You exit the room.'' ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

SWC LISP

2018-09-15T18:41:17Z

Ruben Wan: /* Arithmetic Operators */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|floor || || || || ||
|-
|ceil || || || || ||
|-
|round || || || || ||
|-
|log || || || || ||
|-
|-exp || || || || ||
|-
|modulo || || || || ||
|-
|stochastic_round || || || || ||
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(say "Hello World!") ||"Hello World!" ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(describe "The droid beeps and burps.") ||''The droid beeps and burps.'' ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(ooc "Now go to the mentioned location and talk to the NPC there.") || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.||(add-response "Wow, I didn't know that!" explainmore) ||say "Wow, I didn't know that!" ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. ||(add-action " exit the room." room12) ||''You exit the room.'' ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

SWC LISP

2018-09-15T18:39:11Z

Ruben Wan: /* Conversational Functions */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(say "Hello World!") ||"Hello World!" ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(describe "The droid beeps and burps.") ||''The droid beeps and burps.'' ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.||(ooc "Now go to the mentioned location and talk to the NPC there.") || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.||(add-response "Wow, I didn't know that!" explainmore) ||say "Wow, I didn't know that!" ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. ||(add-action " exit the room." room12) ||''You exit the room.'' ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

SWC LISP

2018-09-15T08:19:11Z

Ruben Wan: /* Conversational Functions */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

==Other Resources==
You can also check out:
http://racket-lang.org/ which is a version of LISP similar to SWC-Lisp and decent to practice with to get the basic idea of programming in LISP.

There is also [http://lisp.plasticki.com/ LISP In Small Parts] which is a good simple overview and basic introduction to LISP's methodology of programming. It primarily focuses on thinking about how to use the language, rather than memorizing the CLISP native functions (which won't help you in SWC-LISP).

===Other Reading===
*[http://www.swcombine.com/rules/?Scripts Scripts Rules Page]
*[http://www.swcombine.com/forum/thread.php?thread=66316&page=0 LISP Changelog Thread]
*[http://www.swcombine.com/forum/thread.php?thread=67116&post=774948#post774948 Public Script Modules List]
*[http://dev.swcombine.com/~selatos/scripting.pdf Original LISP Introduction PDF from Selatos]
*[https://docs.google.com/document/d/1yLxbBREmN59W6cu8hwbV2C39Qdi3M2t7F82AF4lBYx0/ Kay Dallben's Starter Guide]

[[Category:SWC LISP]]

Scripting

2018-09-15T08:15:35Z

Ruben Wan: /* Other Resources */

The scripting language used by SWC is currently available for speeches of Custom NPCs and for interactions with items (e.g. egg incubator).

The new language ([[SWC LISP]]) is a big step ahead from the old system. Here we want to list the major differences with the old system to ease the conversion from the old system to the new one.

==Wildcards (OLD SWC Script Syntax)==
{|class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! SWC Lisp
! Old Wildcard
! Description
! Example
! Default
! For Custom NPCs?
|-
|(get-name self) || %npc.name% || NPC's name || Joe Bloggs || N/A || Yes
|-
|(get-race self) || %npc.race% ||NPC's race ||Nautolan ||N/A ||Yes
|-
| (get-infofield self) ||%npc.infofield% ||NPC's infofield ||Master Carpenter ||N/A ||Yes
|-
|(get-gender self) ||%npc.gender% ||NPC's gender ||Male ||N/A ||Yes
|-
|(get-formal self) ||%npc.formal% ||NPC's formal greeting ||Sir/Ma'am ||N/A ||Yes
|-
|(is-ally? self) ||%npc.ally% ||is NPC IFF friendly? ||N/A ||N/A ||Yes
|-
|(is-enemy? self) ||%npc.enemy% ||is NPC IFF enemy? ||N/A ||N/A ||Yes
|-
|(is-neutral? self) ||%npc.neutral% ||is NPC IFF neutral? ||N/A ||N/A ||Yes
|-
|(is-unharmed? self) ||%npc.unharmed% ||is NPC unharmed? - requires (load "swclib") ||N/A ||N/A ||Yes
|-
|(is-slightly-wounded? self) ||%npc.slightlywounded% ||is NPC slightly wounded?- requires (load "swclib") ||N/A ||N/A ||Yes
|-
|(is-wounded? self) ||%npc.wounded% ||is NPC wounded?- requires (load "swclib")||N/A ||N/A ||Yes
|-
|(is-badly-wounded? self) ||%npc.badlywounded% ||is NPC badly wounded?- requires (load "swclib") ||N/A ||N/A ||Yes
|-
|(get-name character) ||%character.name% ||Character's handle ||Selatos ||N/A ||Yes
|-
|(get-race character) ||%character.race% ||Character's race ||Human ||N/A ||Yes
|-
| (get-infofield character) ||%character.infofield% ||Character's 1st infofield ||Emperor ||Empty String ||Yes
|-
| (get-infofield2 character) ||%character.infofield2% ||Character's 2nd infofield ||1st Recon Division ||Empty String ||Yes
|-
| (get-infofield3 character) ||%character.infofield3% ||Character's 3rd infofield ||2nd Expansionary Fleet ||Empty String ||Yes
|-
|(get-gender character) ||%character.gender% ||Character's gender ||Male ||N/A ||Yes
|-
|(is-unharmed? character) ||%character.unharmed% ||is Character unharmed? - requires (load "swclib")||N/A ||N/A ||Yes
|-
|(is-slightly-wounded? character) ||%character.slightlywounded% ||is Character slightly wounded? - requires (load "swclib")||N/A ||N/A ||]Yes
|-
|(is-wounded? character) ||%character.wounded% ||is Character wounded? - requires (load "swclib")||N/A ||N/A ||Yes
|-
|(is-badly-wounded? character) || %character.badlywounded% ||is Character badly wounded?- requires (load "swclib") ||N/A ||N/A ||Yes
|-
|(get-formal character) || %character.formal% ||Character's formal greeting ||Sir/Ma'am ||N/A ||Yes
|-
|(get-entity-faction character) || %character.faction% ||Character's current faction ||New Republic ||Freelance ||Yes
|-
|(is-owner? character) || %character.isowner% ||Is character the owner of the NPC ||Produces no output ||Empty String ||Yes
|-
|(is-manager? character) || %character.ismanager% ||Is character the manager of the NPC ||Produces no output ||Empty String ||Yes
|-
|(is-pilot? character) || %character.issupervisor% ||Is character the owner of the NPC ||Produces no output ||Empty String ||Yes
|-
|(get-name (get-entity-faction character)) || %faction.name% ||Character's faction's name ||New Republic ||Empty string (if freelance) ||Yes
|-
|(is-freelancer? character) || n.a. ||is the character a freelancer? || || ||Yes
|-
|(faction-type (get-entity-faction character)) || %faction.type% ||Character's faction's type ||Mining ||Empty string (if freelance) ||Yes
|-
|(faction-leader (get-entity-faction character)) || %faction.leader% ||Character's faction's leaders name ||Ellias ||Empty String (if freelance) ||Yes
|-
|(faction-website (get-entity-faction character)) || %faction.website% ||Character's faction's leaders name ||http://swcombine.com (Link) ||Empty string (if freelance) ||Yes
|-
| || %owner.name% ||Name of the NPC's owner ||Darkness ||Empty string if special owner (Market, None) ||Yes
|-
| || %owner.entityType% ||Type of the NPC's owner ||Faction or Character ||Empty string if special owner (Market, None) ||Yes
|-
| || %owner.infofield% ||Owner's 1st infofield ||Emperor ||Empty String ||Yes
|-
| || %owner.infofield2% ||Owner's 2nd infofield ||1st Recon Division ||Empty String ||Yes
|-
| || %owner.infofield3% ||Owner's 3rd infofield ||2nd Expansionary Fleet ||Empty String ||Yes
|-
|(city-name character) || %location.city% ||Current city name ||City 327 ||Unknown ||Yes*
|-
|(planet-name character) || %location.planet% ||Current planet name ||Glee Anselm ||Unknown ||Yes*
|-
|(system-name character) || %location.system% ||Current system name ||Danju ||Unknown ||Yes*
|-
|(sector-name character) || %location.sector% ||Current sector name ||Tapani ||Unknown ||Yes*
|-
| (get-destination entity) || %location.destination% ||Destination name ||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city) ||Unknown ||Yes*
|-
|(get-eta entity) || %location.eta% ||ETA for current travel ||3 days, 24 hours and 5 minutes ||Unknown ||Yes*
|-
|(is-traveling? character) || n.a. ||Checks if the character is traveling or not || || ||Yes
|-
| (get-name (get-container self))|| %container.name% ||Current container name, e.g. the ship or vehicle standing in ||Tydirium ||Unknown ||Yes
|-
|(get-entity-type-name (get-container self)) || %container.type% ||Current container type, e.g. the ship or vehicle standing in ||Lambda Shuttle ||Unknown ||Yes
|-
|(get-type entity-object) || %container.entityType% ||Current container entity type, e.g. the ship, vehicle, city, planet, station ||Ship, Vehicle, City, Planet, Space Station ||N/A ||Yes
|-
|(in-room? entity-object) || n.a. ||Checks if the entity is in any room at all, as opposed to outside on the surface || || ||Yes
|-
| cgt-year|| %cgt.year% ||Gets current CGT year ||12 ||N/A ||Yes
|-
| cgt-day|| %cgt.day% ||Gets current CGT day ||183 ||N/A ||Yes
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||23 ||N/A ||Yes
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||59 ||N/A ||Yes
|-
| cgt-second|| n.a. ||Gets current CGT seconds||59 ||N/A ||Yes
|-
| timeofday|| %time.ofday% ||Gets current phase of day ||Morning, Afternoon, Evening ||N/A ||Yes
|}
Entries with a "Yes" are available for custom NPCs. Entries with a "Yes*" may have some limitations on their use (e.g. they may not be available when the NPC cannot reliably determine the information without godmodding - for example location whilst in hyperspace).

==Custom NPC Environment==
This is the latest posting of functions and constants available to Custom NPCs. Some of these may not be synced to Main yet. Some are also listed above in Wildcards. Where possible, the syntax, required&optional parameters and example usage & evaluation are included.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! SWC Lisp
! Required &Optional ("&") Parameters
! Description
! Example Evaluation
! Default eval
! Testing Status
|-
| self || || The object running the script (NPC, item...). || Test Tickle || n/a ||
|-
| character || || The character interacting with the object running the script. || Kay Dallben || n/a ||
|-
| evar ||| 'name defaultValue || This is a persistent variable in the context of self. See Persistent Variables for usage notes. || special case || defaultValue ||
|-
| ovar || 'name defaultValue || This is a persistent variable in the context of self & character. See Persistent Variables for usage notes. || special case || defaultValue ||
|-
| svar || 'name defaultValue || This is a persistent variable in the context of the current *session*. Session is the interaction between a PC and a scripted entity. See Persistent Variables for usage notes. || special case || defaultValue ||
|-
| #t || || This is "True" || #t || #t ||
|-
| + || a b &d &e … || Basic addition function. Takes at least 2 numbers. || a+b || n/a ||
|-
| - || a b &d &e … || Basic subtraction function. Takes at least 2 numbers. Evaluates as a - b - c - d … or a - (sum b…n) || a-b-c-d… || n/a ||
|-
| > || a b || Preposition. Answers: Is a Greater than b? || #t || n/a ||
|-
| * || a b || Basic multiplication function. Takes at least 2 parameters. || a*b || n/a ||
|-
| / || a b || Basic division function. Takes at least 2 parameters. || a/b || n/a ||
|-
| ge? || a b || Preposition. Answers: Is a Greater than OR equal to b? || #t || n/a ||
|-
| >= || a b || Preposition. Answers: Is a Greater than OR equal to b? || #t || n/a ||
|-
| le? || a b || Preposition. Answers: Is a less than OR equal to b? || #t || n/a ||
|-
| <= || a b || Preposition. Answers: Is a less than OR equal to b? || #t || n/a ||
|-
| gt? || a b || Preposition. Answers: Is a Greater than b? || #t || n/a ||
|-
| || || || || ||
|-
| lt? || a b || Preposition. Answers: Is a less than b? || #t || n/a ||
|-
| < || a b || Preposition. Answers: Is a less than b? || #t || n/a ||
|-
| and || a b &c… || Logical Operand. #t if all its parameters are #t || #t || n/a ||
|-
| or || a b &c… || Logical Operand. #t if any of its parameters are #t. If it finds a #t, it will stop evaluating the rest of the parameters. || #t || n/a ||
|-
| not || a || Logical Operand. #t if a is #f || #t || n/a ||
|-
| concat || stringA &stringB || a concatenated string made up of the provided strings. || abc… || n/a ||
|-
| strlen || string || number of characters in the provided string a || 4 || n/a ||
|-
| trim || string &character_mask || removes:"\0" null "\t" tab "\n" new line "\x0B" vertical tabs "\r" carriage returns and " " spaces. &character_mask can be used to trim only some of those. || sample string || n/a ||
|-
| substr || string start &length || a string made of of the sequential characters within the provided string, beginning at the start character, and ending at &length, if provided. If &length is not provided, the rest of the string is provided. || ample string || n/a ||
|-
| stripos || stringA searchFor &offset || the start position of searchFor if contained in stringA, beginning the search at &offset. || (stripos "sample string" "mp") -> 2 || n/a ||
|-
| length || listA || number of elements in listA || (length (list 'a 'b 'c 'd 4)) -> 5 || n/a ||
|-
| reverse || listA || a list of the reversed elements of listA || (reverse (list 'a 'b 'c)) -> (c b a) || n/a ||
|-
| sublist || listA offset &length &preserve_keys || a list of the elements of listA beginning at offset and continuing to the end of listA OR to &length elements if provided. &preserve_keys should be #t or nil. NOTE: sublist will (perhaps unexpectedly) return strings from a list of symbols. Be aware when using it to get a sublist involving symbols. This is important because (eq? 'a "a") -> #f|| (sublist (list "a" 'b "c") 0 2) -> `("a" "b") || n/a ||
|-
| sort || listA || a list of sorted elements of listA. Sort is alphanumeric. || (sort `(b c a)) -> (a b c) || n/a ||
|-
| nth-of || listA n || the element of listA at position n. 0 is the first element NOTE: nth-of will (perhaps unexpectedly) return strings from a list of symbols. Be aware when using it to get nth-of from a list involving symbols. This is important because (eq? 'a "a") -> #f || (nth-of `(a b c) 1) -> "b" || n/a ||
|-
| rand || &min &max || random number between &min &max. If not provided &min is 0 and &max is ?. See Randomization topic. || (rand 0 5) -> 2 || n/a ||
|-
| rand-from-list || listA || random element from listA NOTE: Be aware that rand-from-list will not return any Symbol if you give it a list of symbols. It will return a STRING if the random element it finds is a symbol. This is important because (eq? 'a "a") -> #f|| (rand-from-list `(a b c)) -> "b" or "a" or "c" || n/a ||
|-
| get-entity-type-id || name || Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station} || (get-entity-type-id 'Planet) -> || n/a ||
|-
| get-type-type || typeID entityType || returns a full TYPE || (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
| get-creature-type || typeID || returns the type of Creature || (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
| get-droid-type || typeID || returns the type of Droid || (get-droid-type 14) gets the droid type obj for Pit Droids || ||
|-
| get-item-type || typeID || returns the type of Item || (get-item-type 298) returns the type of a Focusing Crystal || ||
|-
| get-npc-type || typeID ||returns the type of NPC || (get-npc-type NUM) returns the type for a NPC of typeid NUM || || needs testing
|-
| get-type-of || entity || returns the type object for the entity ||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc) || ||
|-
| get-npc-owner || || returns the "NPC Owner" object || || || useful for an is-unclaimed? check.
|-
| get-hostile-owner || ||returns the "Hostile Owner" object || || || ie checks if it is a spawned Bandit/Creature
|-
| style="white-space: nowrap;"|get-market-owner || || returns the "Market Owner" object || || ||
|-
| get-character || name || entity-object for character "name" || (get-character "Kay Dallben") || n/a ||
|-
| get-faction || name || faction-object for faction "name" || (get-faction "Darkness") || n/a ||
|-
| get-npc || id || npc-object for NPC with ID id || (get-npc 155408) || n/a ||
|-
| get-quest || id || quest-object for quest with ID id || (get-quest 4408) || n/a ||
|-
| get-item || id || item-object for item with ID id || (get-item 481099) || n/a ||
|-
| get-ship || id || ship-object for ship with ID id || (get-ship 448088) || n/a ||
|-
| get-vehicle || id || vehicle-object for vehicle with ID id || (get-vehicle 46846816) || n/a ||
|-
| get-room || id || room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers. || (get-room 4478) || n/a ||
|-
| get-id || entity || ID for the entity || (get-id (get-npc 100)) -> 100 || n/a ||
|-
| get-name || entity || name of the object || (get-name (get-vehicle 1150488)) || n/a ||
|-
| get-formal || entity || Sir if gender is male, Maam if gender is female. || (get-formal (get-character "Kay Dallben")) -> Sir || n/a ||
|-
| get-infofield || entity || string of the first infofield of entity || (get-infofield (get-npc 111548)) || empty string ||
|-
| get-infofield2 || pc-entity || string of the 2nd infofield of entity || (get-infofield2 (get-character "Kay Dallben")) || ||
|-
| get-infofield3 || pc-entity || string of the 3rd infofield of entity || (get-infofield3 (get-character "Kay Dallben")) || ||
|-
| get-race || entity || string representing race of the entity || (get-race self) || n/a ||
|-
| get-gender || entity || string of the gender of entity || (get-gender self) ->Male || n/a ||
|-
| get-hp-status-text || entity || string of the hp-status-text {unharmed, slightly-wounded, etc.} || (get-hp-status-text self) || n/a ||
|-
| is-ally? || test &source || Preposition. Answers: is test an ally to &source (default: self) || (is-ally? (get-npc 445158)) || n/a ||
|-
| is-neutral? || test &source || Preposition. Answers: is test neutral to &source (default: self) || (is-neutral? (get-npc 4408)) || n/a ||
|-
| is-enemy? || test &source || Preposition. Answers is test an enemy to &source (default: self) || (is-enemy? (get-npc 4408)) || n/a ||
|-
| is-freelancer? || test-character || Preposition. Answers: is test-character a freelancer? || (is-freelancer? (get-character "Kay Dallben")) -> #T || n/a ||
|-
| faction-owned? || entity || Preposition. Answers: is the entity owned by a faction? || (faction-owned? self) || n/a ||
|-
| get-entity-faction || entity || faction-object for the faction entity belongs to? || || n/a || needs testing
|-
| faction-type || faction-entity || type of faction || String? || || needs testing
|-
| faction-leader || faction-entity || leader of faction || String? || || needs testing
|-
| faction-website || faction-entity || website of faction || String? || || needs testing
|-
| get-owner || entity || owner object of entity || (get-owner self)-> Kay Dallben || ||
|-
| get-type || entity || type of entity || type ID or string? || || needs testing
|-
| get-entity-type-name || entity || name of type of entity || string? || || needs testing
|-
| is-owner? || || Preposition. Answers: is character the owner of self || (is-owner?) -> #t || n/a ||
|-
| is-commander? || || Preposition. Answers: is character the commander of self || (is-commander?) || ||
|-
| is-manager? || || Preposition. Answers: is character the manager of self || (is-manager?) || ||
|-
| is-pilot? || || Preposition. Answers: is character the pilot of self || (is-pilot?) || ||
|-
| is-supervisor? || || Preposition. Answers: is character the supervisor of self || (is-supervisor?) || ||
|-
| in-room? || entity || Preposition. Answers: is entity in the same room as self? || (in-room? (get-NPC 4808)) || n/a ||
|-
| is-traveling? || entity || Preposition. Answers: is entity travelling? || (is-traveling? (get-ship 3334)) || n/a ||
|-
| get-container || entity || entity-object for container of entity. || (get-container self) || n/a ||
|-
| get-destination || entity || destination of entity || || || needs testing
|-
| get-eta || entity || eta of arrival of entity to its destination || || || needs testing
|-
| get-location || entity || String of location (currently including hyperlinks) if viewable without godmoding. || || || needs testing
|-
| city-name || entity || Name of the city containing entity? || || || needs testing
|-
| planet-name || entity || name of the planet containing entity? || || || needs testing
|-
| system-name || entity || name of the system containing entity? || || || needs testing
|-
| sector-name || entity || name of the sector containing entity? || || || needs testing
|-
| send-message || sender receiver message &subject || Output: Sends a DM to receiver, from sender with message and subject &subject. Receiver and Sender must be any PC-object and self || || || needs testing
|-
| flash ||style="white-space: nowrap;"| type{'green 'red 'blue 'good 'bad 'info} message || Puts a small coloured bar with the message on the screen of character. || (flash 'green "You did it!") || n/a ||
|-
| null || || null || || null ||
|-
| empty || || Use for the empty list `() || || null ||
|-
| nil || || aka #f || || null ||
|-
| cgt-year || || current year || || ||
|-
| cgt-day || || current day || || ||
|-
| cgt-hour || || current hour || || ||
|-
| cgt-minute || || current minute || || ||
|-
| timeofday || || string of timeofday Morning Afternoon Evening Night || || n/a ||
|-
| teleport-to-room || entities container room || ? || || || needs testing
|-
| leave-room || character direction || ? || || || needs testing
|-
| say || message &close || Output: NPC "says" message. &close is boolean. If true, this will start a new paragraph. || || ||
|-
| describe || message &close || Output: NPC "describes" message. &close is boolean. If true, this will start a new paragraph. || || ||
|-
| ooc || message &close || Output: NPC "oocs" message. &close is boolean. If true, this will start a new paragraph. || || ||
|-
| say-c || message || Output: NPC "says" message, continuing previous paragraph and using that formatting || || ||
|-
| describe-c || message || Output: NPC "describes" message, continuing previous paragraph and using that formatting || || ||
|-
| ooc-c || message || Output: NPC "oocs" message, continuing previous paragraph and using that formatting || || ||
|-
| add-response || message callback || Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
| add-action || message callback || Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
| add-text || message callback || Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
| add-input || not implemented || Input: creates a text box for the user to type something in. In progress. || || ||
|-
|}

==Conditional Statements==
The biggest differences are:
* the "=" is no longer used to do comparisons;

Old system:
<pre>!if character.race=Gungan! Don't slip over!
!if character.race=Human! Humans are the best!
!ifnot character.race=Human! Alien scum!</pre>

New system:
<pre>(cond
[(eq? (get-race character) "Gungan") (say "Don't slip over!") (say "Alien scum!")]
[(eq? (get-race character) "Human") (say "Humans are the best!")]
[#t (say "Alien scum!")])</pre>
OR
<pre>(cond[(eq? (get-race character) "Gungan") (say "Don't slip over!") (say "Alien scum!")])
(cond [(is-owner?) (say "Oh, uh. Welcome Boss!")]</pre>

* with ''cond'' statement, the conditions are tested sequentially until one of them is true, and then it evaluates it and stops testing. This is much like an If...ElseIf...ElseIf. This means that if you have two statements, you must put them inside the same condition. If you have multiple alternate conditions (ElseIfs) to test, you must ensure that at least one of them evaluates true '''every time'''. Commonly this is done with a final [#t] condition.
* You can use ''cond'' statements as a simple IF by only including one test.

Old system:
<pre>Responses:
!if character.race=Baragwin! !if character.gender=Female! Excuse me, how do you know I am a female? -> Baragwin female
!if character.race=Baragwin! !if character.gender=Male! Excuse me, how do you know I am a male? -> Baragwin male
!ifnot character.race=Baragwin! I'd like to have more information on the museum. -> info
!ifnot character.race=Baragwin! What can I do here? -> what to do
!ifnot character.race=Baragwin! Do I need to pay an entrance fee? -> fee</pre>

New system: NOTE: Technically, the last ElseIf can just be #t rather than (not (eq? (get-race character) "Baragwin")). This is because the first two checks cover all cases where the character could be a Baragwin (female or male).
<pre> (cond
[(and (eq? (get-race character) "Baragwin") (eq? (get-gender character) "Female"))
(add-response "Excuse me, how do you know I am a female?" Baragwin-female)]
[(and (eq? (get-race character) "Baragwin") (eq? (get-gender character) "Male"))
(add-response "Excuse me, how do you know I am a male?" Baragwin-male)]
[(not (eq? (get-race character) "Baragwin"))
(add-response "I'd like to have more information on the museum." info)
(add-response "What can I do here?" what-to-do)
(add-response "Do I need to pay an entrance fee?" fee)][#t])</pre>

Note 2: Also, since the two add-responses in the first cases are so similar, you can combine them and toss the M/F determination, if important, into the Baragwin defun next conversation step.
<pre>(cond
[(eq? (get-race character) "Baragwin") (add-response (concat "Excuse me, how do you know I am a " (get-gender character) "?") Baragwin-female)]
[#t
(add-response "I'd like to have more information on the museum." info)
(add-response "What can I do here?" what-to-do)
(add-response "Do I need to pay an entrance fee?" fee)])
</pre>

==Variable Examples==
The following little script shows how to use session variables.
(defvar hp-session-var (svar 'hp 10))
(defvar str-session-var (svar 'str 5))
(defvar rand-val (svar 'rand (rand 1 5)))
(defvar setted-rand-val (svar 'setted-rand-val (rand 11 15)))

(defun (incr-hp val)
(set-var! hp-session-var (+ hp-session-var val)))

(defun (incr-str val)
(set-var! str-session-var (+ str-session-var val)))

(defun start
(ooc (concat "Your HP is: " hp-session-var ". Your Str is: " str-session-var ". The rand-val is: " rand-val ". The 'setted-rand-val' is: " setted-rand-val "." ) )
(add-action "Set the setted-rand-val to store the rand between 6 and 10 for the whole session." set-rand-val)
(add-action "Add 2 HP" add-2hp)
(add-action "Sub 4 HP" sub-4hp)
(add-action "Add Str to HP" add-str-to-hp)
(add-action "Add Rand 1 - 9 to Str" add-rand-to-str))

(defun add-2hp (incr-hp 2) (start))

(defun sub-4hp (incr-hp -4) (start))

(defun add-str-to-hp (incr-hp str-session-var) (start))

(defun set-rand-val
(set-var! setted-rand-val (rand 6 10)) (start))

(defun add-rand-to-str (incr-str (rand 1 9)) (start))

==Basic Custom NPC Interaction==
===Conversation===
{|
! Syntax
! Example of Use
! Actual Output
|-
|'''say''' string || (say "Hello World!") || "Hello World!"
|-
|'''describe''' string || (describe "The droid beeps and burps.") || ''The droid beeps and burps.''
|-
|ooc string || (ooc "Now go to the mentioned location and talk to the NPC there.") ||
|-
|add-response string next-function) || (add-response "Wow, I didn't know that!" explainmore) || say "Wow, I didn't know that!"
|-
|add-action string next-function || (add-action " exit the room." room12) || ''You exit the room.''
|}

==LISP Language Functions==
These are some general CLISP functions that are useable in SWC-LISP, and not necessarily included in the dbg-env tables above.
{|class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! SWC Lisp
! Required &Optional ("&") Parameters
! Description
! Example Evaluation
! Default eval (if applicable)
|-
|car || ''list'' || The first element of the list. Aka 'First' || (car `(1 2 3)) -> 1 || n/a
|-
|cdr || ''list'' || A list of all the elements of the list, in order, except the first. AKA 'Rest' || (cdr `(1 2 3)) -> (2 3) || n/a
|-
|cons || ''expr1'' ''expr2'' || constructs a list from the two expressions provided. Typically used to prepend an element onto a list (push), using (cons atom1 list). Careful when consing atoms only. That creates a "dotted list" which can result in unexpected behaviour. If you want to make a list with just one element, either use (list atom) or `(atom), or (cons atom `()) aka (cons atom empty). || (cons 1 `(2 3)) -> (1 2 3) || n/a
|-
|list || ''expr1'' ''expr2'' ... ''exprN'' || Constructs a list out of atoms or lists, or I guess symbols. || (list 1 2 `(3)) -> (1 2 (3)) || n/a
|-
|empty? || ''list'' || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. || style="white-space: nowrap;"|(empty? `()) -> #t (empty? `(1)) -> #f || n/a
|-
|eq? || ''atom1'' ''atom2'' || Preposition: Are the two provided atoms equal? Unsure exactly which "eq" from LISP documentation this really is. Does not work for Lists. || (eq? 1 1) -> #t (eq? 1 2) -> #f ... || n/a
|-
|nth-of || ''list'' ''index#'' || aka "nth". Returns the nth element of list. Note: 0 is the first element. || (nth-of `(1 2 3) 0) -> 1;

(nth-of `(1 2 (3 4)) 2 -> (3 4)
|| n/a
|-
|floor
|-
|ceil
|-
|round
|-
|log
|-
|-exp
|-
|modulo
|-
|stochastic_round
|}

==How to Pass Parameters in Functions==
Below you can see a simple example of creating a function accepting two parameters, and passing them.

(defun (myfun a b)
(ooc (concat "I do something with " a ", then I do something with " b)))

(defun start
(myfun "turkey" "salami"))

Another example with numbers. This calculate the absolute of a number.
(defun (abs x)
(cond
[(lt? x 0) (* x -1)]
[#t x]))

(defun start
(say (concat "The absolute of 20 + -44 is " (abs (+ 20 -44)))))

[[Category:Features]]
[[Category:Advanced Activities]]

SWC LISP

2018-09-15T08:14:17Z

Ruben Wan: /* Conversational Functions */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]
*[http://www.swcombine.com/rules/?Scripts Rules page on lisp]

[[Category:SWC LISP]]

SWC LISP/Debugging and Errors

2018-09-14T23:24:28Z

Ruben Wan: /* Debugging Functions */

==Debugging Functions==
* <code>dbg-break</code> triggers an exception (ignoring the rest of the script) and print supplied values, for example <code>(dbg-break self character (+ 1 2))</code> will display info about the current entity, current character, and the number 3
** note that if you put <code>(dbg-break)</code> in the global scope (a line on its own), it'll block the whole script at startup. Instead, you must use it inside another function, in the point where you want the script to stop.
* <code>dbg-pp</code> prints values for debugging without triggering an exception (script continues), using the same semantics as <code>dbg-break</code>
* <code>dbg-env</code> dumps the entire symbol table (very large) and can be used to get basic information about the API to help with missing documentation
* <code>dbg-rp</code> provides low-level view of data structures

==Understanding Errors==
Most often, if you get an error it is a problem of parenthesis. When you save the script, the parser checks only for matching parenthesis; however, if the total of open parenthesis matches the total of closed parenthesis, the parser reports no errors on saving.

===Symbol [name] is not defined!===
If you get this error while the script runs, it could mean that there are misplaced parenthesis. In this case, go through your script placing your cursor on the end parenthesis to see if everything is ok.

If the error is not due to misplaced parenthesis, check that the name is not mispelt. If ok, check that the call to the function comes before the function called.

===Symbol -> is not defined!===
It is the easiest to fix. You've just written a "->" in an add-response function, between the end of text and the name of the function to go to. The old system used that symbol, but the new system need not that. Just remove that "->".

A second case is if you've added a parameter to the describe function different from close. Example, the old 'left alignment keyword, now invalid.

===Symbol is undefined and cannot be evaluated===
You've probably forgotten to specify where to go after an add-response text. Simply add the name of the function to continue with.

Mind the parenthesis if you have a concat function in add-response or other function with parameters. Example, this code is right:

(defun start
(say "Hello, how may I help you?")
(cond
[(eq? (get-race character) "Kuati")
(add-response "Excuse me, your dress is very elegant. May I know what caste are you?" caste01)]
[(not (eq? (get-race character) "Kuati"))
(add-response (concat "I see you are a " (get-infofield self) ". What do you do, exactly?") do01)
(add-response "Are you a real expert on ships?" expert01)
(add-response "Very kind of you, but I am just browsing. No need for help." end01)]))

but if you write the add-response with the concat function as
(add-response (concat "I see you are a " (get-infofield self) ". What do you do, exactly?" do01))

you get this type of error, because the closing parenthesis of the concat function must go after the string end and before the next-function-name parameter.

====Symbol set-var is undefined and cannot be evaluated====
The correct syntax is set-var! (with the 'bang') and not set-var or setvar. Check your syntax.

===Invalid speech option selected===
This is a generic error, meaning that any thing wrong in the next-function-name called by the user click may cause this error. A syntax error, a logic error... Below you find some examples. Note that this error appears when you try to click on an answer, therefore you should look for the function called by that answer. You can use the (dbg-xx) functions in the functions called by the add-action/add-response/add-text to check your code for unexpected evaluation results.

* If you're trying to concatenate a text with a describe, you'll get this error. Example: 
(say (concat "Well, another protocol droid you can see here is the SP-4. It is defined as an analysis droid and it uses the same chassis and many parts assembled in the cheaper PK-series worker droid. You cannot say that it is made to resemble its owner..." (describe "winks")))

The solution is to put the describe in a single line, all alone, and remove the concat in the say function. `concat` only assembles several strings into one string. `describe` is a function that does not evaluate to a single string, and so concat cannot make proper use of it.

* A conditional statement with a wrong use of keywords:
(eq? (get-entity-faction character) "Galactic Empire")
is bugged;
(eq? (get-name (get-entity-faction character)) "Galactic Empire")
is correct.

* Adding a missing [#t] to a conditional statement.

===Attempted to evaluate a literal value or a null: "somestring"===
One possible case is that you are trying to call a function that needs a parameter from inside an add-response function. As of Y19D270, add-response can only call simple functions, without parameters. 
In order to solve this problem, you should make an intermediate function. Example:
(add-response "Please forward this parameter." (intermediate-fun))
(defun intermediate-fun (get-parameter "Here is the parameter"))
(defun (get-parameter thisparameter)
code code code)

===Not enough arguments supplied in function call===
You have called a function that is expecting one or more parameters, but you have not specified any parameter. 
Solution: add the parameters needed.

===`set-var!` can only be called on *vars===
wip

[[Category:SWC LISP]]

SWC LISP

2018-09-14T23:23:19Z

Ruben Wan: /* Variables */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Declarations==
; (defun (foo bar (baz 1)) code code code) : declares a function named ''foo'' with a required argument ''bar'' and an optional argument ''baz'' that defaults to 1 if not given.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]

SWC LISP

2018-09-14T23:20:25Z

Ruben Wan: /* Definitions */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; hook : this allow asynchronous notification of events to different areas of code or LISP scripts (primarily in support of scripting responses to in-game events)
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]

SWC LISP

2018-09-14T23:17:50Z

Ruben Wan: /* Others */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events (combat, travel, asset transfer, etc. for use with quests) and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]

SWC LISP

2018-09-14T23:16:20Z

Ruben Wan: /* Conversational Functions */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. ''&close'' is boolean (defaults to true). If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting, without inserting linebreaks || || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. Useful for multi-step decision trees, options menus, etc. that may not need to print something from the player's perspective || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|clear-window|| ||Clears the current conversation log window before rendering the information from the current interaction || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]

SWC LISP

2018-09-14T23:09:54Z

Ruben Wan: /* Conditional Statements */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

==Others==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| create-hook|| ||Creates a hook that listen to specific in-game events and then call a lisp function || || ||
|-
| get-hook || ||Retrieves a hook by ID || || ||
|-
| delete-hook || ||Deletes an existing hook || || ||
|-
|}

==Conversational Functions==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|say||message &close||Output: NPC "says" message. ''&close'' is boolean. If true, this will start a new paragraph.|| || ||
|-
|describe||message &close||Output: NPC "describes" message. &close is boolean. If true, this will start a new paragraph.|| || ||
|-
|ooc||message &close||Output: NPC "oocs" message. &close is boolean. If true, this will start a new paragraph.|| || ||
|-
|say-c||message ||Output: NPC "says" message, continuing previous paragraph and using that formatting|| || ||
|-
|describe-c||message||Output: NPC "describes" message, continuing previous paragraph and using that formatting|| || ||
|-
|ooc-c||message ||Output: NPC "oocs" message, continuing previous paragraph and using that formatting|| || ||
|-
|add-response||message callback ||Input: Adds a clickable option labelled 'message' that will a) display "You say " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters.|| || ||
|-
|add-action||message callback||Input: Adds a clickable option labelled 'message' that will a) display "You " message; and b) run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-text||message callback||Input: Adds a clickable option labelled 'message' that will not display anything and simply run the callback function. NOTE: Currently the callback functions may not have any parameters. || || ||
|-
|add-input||not implemented||Input: creates a text box for the user to type something in. In progress. || || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]

SWC LISP

2018-09-14T22:58:18Z

Ruben Wan: /* Lists */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
| sort || ||Numerical sorting of lists || || ||
|-
| length || ||Returns the length of a list || || ||
|-
| nth-of || ||Returns the nth element of a list || || ||
|-
| sublist || ||Returns some number of elements from the middle of a list || || ||
|-
| reverse || ||Reverses the elements in a list (at the top level) || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]

SWC LISP

2018-09-14T22:52:15Z

Ruben Wan: /* Strings */

Main page - trying to reorganise the LISP content

SWC-LISP can be considered a fork from the main Lisp branches that is used to interact with the Combine's database. For this reason it is not used to create stand-alone applications, rather dialogue scripts for Custom NPCs or working procedures for objects as well as implementing game-wide quests.

==Definitions==
Notation for a sequence of things is often 1 2 ... n, where the first couple things give you an idea of how the sequence goes (in this case incrementing by 1), the ellipses (...) indicate it continues. When referring to any specific 'thing' in that sequence, we talk about its position. 1 is the ''first'' thing. 2 is the ''second'' thing, and all the way at the end, the term n representing the last thing in that sequence is the "nth" thing. We use the same kind of notation and terms to discuss lists.

; atom : a single 'thing' - the smallest unit thing in LISP. It is an s-expression, but more than that it is a value, number,
; boolean : Boolean is a data type that can be either True or False. We often refer to functions which return #t or #f as '''''predicates''''', and in SWC-LISP, the convention is to name those functions ending with a question mark. If i made a predicate to check if numbers a and b are both 2, i'd name it both-two?
; define : in the sense of LISP, this means to formally tell the script what you want a given ''symbol'' to evaluate to. You use two functions for this: ''defvar'' for variables and ''defun'' for functions.
; element : We often refer to each 'thing' inside a list as an ''element''. It's useful to have a term for this since we discuss how lists are navigated and need common ways to talk about it.
; evaluate : More or less this means 'determine the meaning of '. This action is what the LISP interpreter does for every s-expression. We often say an s-expression 'evaluates to' something else, and many LISP books use the notation => to indicate that. E.G. 1=> 1; (defvar blue "Red") blue=> "Red"; (+ 1 7) => 8; (concatenate "My favourite colour is " blue) => "My favourite colour is Red"
; functions : Instructions to the interpreter on what to do. You define these using ''defun'' telling the interpreter a) what you want the symbol to be, b) if you want to feed your function data (''parameters''), what temporary symbols you will use to refer to each parameter ("''local variables''"), and what function that symbol should evaluate to. More on this later, but the important concept is that functions are your way of directing what you want to happen, when.
; lambda functions : They are (generally) function definitions not bound to an identifier - or in our case a symbol. They can be used anywhere you'd normally use a defined function name by directly describing its behavior rather than indirectly by referring to the name of an established function (Excepting add-action, add-response, add-text). I primarily use them in more interesting ways than the above in order to create temporary functions based on a template. In general, they are a way of defining a function for use in an s-expression without having to name the function. You can think of it as the function equivalent of passing a string value as "Blue" instead of (defvar colour "Blue") colour.
; list : a group of s-expressions represented in the form (s-expression1 s-expression2 ... s-expressionN). A list is itself an s-expression, so can be contained inside other lists.
; parameter : a piece of data you feed to a function, upon which it operates. Also known as ''input''. These are often listed as an expected type - for example ''defvar'' expects a ''symbol'' and a ''value'', while ''say'' expects a ''string''.
; quoting : Lisp must decide which parts of our program consist of code (stuff to be executed) and which parts are just data. Whenever you type something, Lisp assumes that you’re entering a command you want to execute. In other words, Lisp always assumes that you’re writing code and defaults to ''code mode''. On the other hand, stuff written in ''data mode'' is treated as data. This means the computer will not try to "execute" it, which allows us to have information in our code that’s just plain old data. The '''single quote '''' tells Lisp to treat the subsequent form as a chunk of data — simply a list of items. Lisp then prints the result of evaluating what we entered, which is the list itself. It ignores any functions or variables in our list, treating everything as data. Example: (+ 2 3) => 5 whereas '(+ 2 3) => (+ 2 3).
; quasiquoting : This feature allows us to create chunks of data that have small pieces of Lisp code embedded in them. To enable quasiquoting, you must use a ''backquote'' [`] not a single quote ['] when switching from code to data mode. Both the single quote and backquote in Lisp "flip" a piece of code into data mode, but only a backquote can also be unquoted using the ''comma'' character, to flip back into code mode. Example: <code>`(a b ,character)</code> produces a list that contains the symbols a and b, followed by the value of the symbol character. The first two are not evaluated, but the third is.
; s-expression : a general term that means an atom or a grouping of atoms called a ''list''.
; scope : Really we mean ''lexical scope'', which sets the range of functionality of a symbol so it can only be used inside the part of the script it is defined in. This is a longer subject and will be covered in more detail later, but when we talk about scope, we're talking about where we can use a particular defined symbol and where we cannot.
; session : a unique interaction between a character and a scripted entity. Lasts as long as the script is still running.
; string : A set of letters and numbers that the interpreter does not evaluate further - treats it as text. "Blue" is a string, while Blue is a symbol. (defvar colour "Blue") defines the symbol `colour` to evaluate to the string "Blue". You can also feed defvar (or other functions) a symbol which evaluates to the expected type. (defvar some-colour colour) would then set the symbol `some-colour` to evaluate to the symbol `colour`, which evaluates to the string "Blue".
; symbol : looks just like any other word in the code. It's exactly what you intuit it to mean: a representation of something else - a value, a string, a function, a list, etc.
; variables : As a programming term, it is a storage location paired with a symbolic name. For our purposes, it's a symbol that will evaluate to a set "something" stored: a value, another symbol, a function, etc.). (defvar symbol value) is the general form, and that makes an unchangeable variable, which you can then refer to as `symbol` for the rest of the script. There are exceptions/provisos/caveats, but they'll be discussed as they come up.

==Variables==
* *vars can now properly handle lists of values in addition to scalar values. Storing an instance of a class is not supported and (should) result in an exception being thrown.

==Predicates==
The following table lists functions that return either #t or #f.

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|is-unharmed?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "unharmed"||(is-unharmed? character)||#t||(load "swclib")
|-
|is-slightly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "slightly wounded"||(is-slightly-wounded? character)||#f||(load "swclib")
|-
|is-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "wounded"||(is-wounded? character)||#f||(load "swclib")
|-
|is-badly-wounded?||player-NPC-object||Returns true if player-NPC-object's HP-Status-Text is "badly wounded"||(is-badly-wounded? character)||#f||(load "swclib")
|-
|in-same-faction?||entityA entityB||Returns true if entity A and B are in or owned by the same faction. Can be written (eq? (get-entity-faction entityA)(get-entity-faction entityB))||(in-same-faction? )||#t||(load "swclib")
|-
|in-container?||object container||Returns true if object is inside container||(n-container? hilt toolkit)||#t||(load "swclib")
|-
|is-ally?||player-NPC-object||Returns true if NPC/PC is IFF friendly (defaults to self)||(is-ally? self)||#t||
|-
|is-enemy?||player-NPC-object||Returns true if NPC/PC is IFF enemy (defaults to self)||(is-enemy? self)||#f||
|-
|is-neutral?||player-NPC-object||Returns true if NPC/PC is IFF neutral (defaults to self)||(is-neutral? self)||#f||
|-
|is-owner?||player||Returns true if character is the owner of the NPC||(is-owner? character)||#t||
|-
|is-commander?||player||Returns true if character is the commander of the NPC ||(is-manager? character)||#t||
|-
|is-manager?||player||Returns true if character is the manager of the NPC ||(is-manager? character)||#t||
|-
|is-pilot?|| player ||Returns true if character is the owner of the NPC ||(is-pilot? character)||#t||
|-
|is-supervisor? ||player||Returns true if character is the supervisor of the NPC||(is-supervisor?)||#t||
|-
|is-freelancer?|| player ||Returns true if the character is a freelancer||(is-freelancer? character)||#t||
|-
|is-traveling?|| player ||Checks if the character is traveling or not ||(is-traveling? character)||#t||
|-
|in-room?|| entity-object ||Checks if the entity is in any room at all, as opposed to outside on the surface ||(in-room? entity-object)||#t||
|-
|faction-owned?||entity||Returns true if the entity is owned by a faction ||(faction-owned? self)||#t||
|-
|empty? ||list || checks if you have an empty list. Can have unexpected behaviour if attempting to store an empty list in a persistent variable. ||1. (empty? `()) 2. (empty? `(1))||1. #t 2. #f ||
|-
|in? ||needle haystack||Returns true if one or more of the elements of ''haystack'' is equal to ''needle''. ''needle'' is an atom and ''haystack'' is a list of atoms ||(in? 3 (list 1 'a 6 3 'u)) ||#t ||(load "funlib")
|-
|sublists-empty? ||list-of-lists || Returns true if any of the sublists are empty. Note: the function expects only lists, no atoms at the top level || || ||(load "funlib")
|-
|earlier? ||timeA timeB || Returns true if ''timeA'' is less than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|later? ||timeA timeB || Returns true if ''timeA'' is greater than ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|same-time? ||timeA timeB || Returns true if ''timeA'' is equal to ''timeB''. timeA and timeB are two time objects || || ||(load "timelib")
|-
|enum-valid? || || Tests a value for being part of an enum || || ||
|}

==Operators==
===Arithmetic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| +||number1 number2 &numberN||Adds numbers together||(+ 5 2)||7||
|-
| -||number1 number2 &numberN||Subtracts numbers||(- 5 2)||3||
|-
|*||number1 number2 &numberN||Multiplies numbers||(* 5 2)||10||
|-
|/||number1 number2||Divides numbers||(/ 10 2)||5||
|-
|abs||number||Returns the absolute value of number||(abs -10)||10||(load "mathematics")
|-
|power||number exponent||Returns the value of numberexponent||(power 2 3)||8||(load "mathematics")
|-
|minof||list-of-numbers||Returns the minimum value from a list of numbers||(minof '(2 3 7 9 1 18))||1||(load "mathematics")
|-
|maxof||list-of-numbers||Returns the maximum value from a list of numbers||(maxof '(2 3 27 9 1 18))||27||(load "mathematics")
|-
|neg?||number||Returns true if number is negative, nil if positive||(neg? -1)||#t||(load "mathematics")
|-
|pos?||number||Returns true if number is positive, nil if negative||(pos? 1)||#t||(load "mathematics")
|-
|zero?||number||Returns true if number is 0, nil if otherwise||(zero? 0)||#t||(load "mathematics")
|-
|factorial||number||Returns !number||(factorial 5)||120||(load "mathematics")
|-
|common-number-format||number||Returns a string with commas separating the thousands||(common-number-format 10000.51)||"10,000.51"||(load "mathematics")
|-
|add-leading-zeros||number &HowManyDigits||Returns a string of value = number, with optional integer HowManyDigits leading zeros. HowManyDigits defaults to 1||1. (add-leading-zeros 3) 2. (add-leading-zeros 30) 3. (add-leading-zeros 3 2) 4. (add-leading-zeros 30 2)||1. "03" 2. "30" 3. "003" 4. "030"||(load "mathematics")
|-
|}

===Comparison Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|ge?||number1 number2||Is number1 equal to or greater than number2?||(ge? 5 2)||#t||
|-
|le?||number1 number2||Is number1 equal to or less than number2?||(le? 5 2)||#f||
|-
|gt?||number1 number2||Is number1 greater than number2?||(gt? 5 2)||#t||
|-
|lt?||number1 number2||Is number1 less than number2?||(lt? 5 2)||#f||
|-
|eq? || atom1 atom2 || Returns true if the two provided atoms are equal. Does not work for Lists. ||1. (eq? 1 1) 2. (eq? 1 2)||1. #t 2. #f||
|-
|neq?||atom1 atom2||Returns true if atom 1 is not equal to atom 2||(neq? 1 2)||#t||(load "funlib")
|-
|eq-lists?||listA listB||Returns true if all elements of list A are equal to all elements of list B. As of Y19D290 it doesn't take into account lists of lists, but only one-dimensional lists||1. (eq-lists? '(a b c) '(d e f)) 2. (eq-lists? '(a b c) '(a b c)) 3. (eq-lists? '( '(a) b c))||1. #f 2. #f 3. Error||(load "funlib")
|-
|}

===Logic Operators===
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|and||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if all exprs are true||(and? #t #f)||#f||
|-
|or||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns true if at least one expr is true||(or #t #f)||#t||
|-
|not||boolean-expression1 boolean-expression2 &boolean-expressionN||Returns the opposite value||(not #t)||#f||
|-
|}

==Getters==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|get-name||player-NPC-object|| Returns the name of the entity ||1. (get-name self) 2. (get-name (get-entity-faction character)) 3. (get-name (get-container self)) 4. (get-name (get-vehicle 1150488))||1. Johnny Walker 2. New Republic (empty string if Freelance 3. Tydirium (Current container name, e.g. the ship or vehicle standing in) 4. My vehicle||
|-
|get-race|| player-NPC ||Returns the PC/NPC's race as string ||(get-race self)||Nautolan ||
|-
|get-infofield||player-NPC ||Returns the string of the first infofield of PC/NPC's||1. (get-infofield self) 2. (get-infofield (get-npc 111548)) ||1. Master Carpenter 2. empty string ||
|-
|get-infofield2||player-NPC ||Returns the string of the 2nd infofield of PC/NPC's||1. (get-infofield2 self) 2. (get-infofield2 (get-character "Kay Dallben")) ||1. O-4 2. ||
|-
|get-infofield3||player-NPC ||Returns the string of the 3rd infofield of PC/NPC's||1. (get-infofield3 self) 2. (get-infofield3 (get-character "Kay Dallben")) ||1. Inactive 2. ||
|-
|get-gender||player-NPC ||Returns the PC/NPC's gender as a string ||(get-gender self)||Male ||
|-
|get-formal||player-NPC ||Returns the PC/NPC's formal greeting (Sir if gender is male, Ma'am if gender is female.) ||(get-formal (get-character "Kay Dallben")) ||Sir ||
|-
|get-entity-faction|| player-NPC ||Returns the PC/NPC's current faction ||(get-entity-faction character)||Galactic Empire ||
|-
|get-destination|| entity ||Returns the destination name ||(get-destination entity)||"Corellia sector" (if deep space) "Corellia system" (if heading to that system) 
"Corellia planet" (if heading in sublight) "Atmosphere (3,4) of Corellia" (if heading in atmo) "Ground (3,4) of city Cityname on Corellia" (if heading to ground in city) "Ground (3,4) at (4,7) on Corellia" (if heading to ground outside a city)
|-
|get-eta|| entity ||Returns the ETA for current travel ||(get-eta entity)||3 days, 24 hours and 5 minutes ||
|-
|get-entity-type-name|| entity ||Returns the name of the type of the entity|| (get-entity-type-name (get-container self)) ||Lambda Shuttle||
|-
|get-type|| entity-object ||Returns the current container entity type, e.g. the ship, vehicle, city, planet, station ||(get-type entity-object)||Ship, Vehicle, City, Planet, Space Station||
|-
|get-entity-type-id||name||Type ID for the entity type name. {Ship, Vehicle, City, Planet, Space Station}||(get-entity-type-id 'Planet) -> ||n/a||
|-
|get-type-type||typeID entityType||returns a full TYPE|| (get-type-type 298 (enum "EntityType" "ITEM")) is equal to (get-item-type 298) || ||
|-
|get-creature-type||typeID||returns the type of Creature|| (get-creature-type 175) returns the type for an Eye-Snatcher || ||
|-
|get-droid-type ||typeID|| returns the type of Droid||(get-droid-type 14) gets the droid type obj for Pit Droids|| ||
|-
|get-item-type ||typeID|| returns the type of Item||(get-item-type 298) returns the type of a Focusing Crystal || ||
|-
|get-npc-type||typeID||returns the type of NPC||(get-npc-type NUM) returns the type for a NPC of typeid NUM|| ||needs testing
|-
|get-type-of||entity||returns the type object for the entity||(get-type-of self) could return the type for a Quest NPC (if self is a quest npc)|| ||
|-
|get-npc-owner || ||returns the "NPC Owner" object|| || ||useful for an is-unclaimed? check.
|-
|get-hostile-owner|| ||returns the "Hostile Owner" object|| || ||ie checks if it is a spawned Bandit/Creature
|-
|get-market-owner|| ||returns the "Market Owner" object || || ||
|-
|get-character || name ||entity-object for character "name"||(get-character "Kay Dallben")||n/a||
|-
|get-faction||name||faction-object for faction "name"||(get-faction "Darkness") ||n/a||
|-
|get-npc||id||npc-object for NPC with ID id||(get-npc 155408)||n/a||
|-
|get-quest||id||quest-object for quest with ID id||(get-quest 4408)||n/a||
|-
|get-item||id||item-object for item with ID id||(get-item 481099)||n/a||
|-
|get-ship||id||ship-object for ship with ID id||(get-ship 448088)||n/a||
|-
|get-vehicle||id||vehicle-object for vehicle with ID id||(get-vehicle 46846816)||n/a||
|-
|get-room||id|| room object for room ID. Rooms are commonly numbered among ALL of a given entity type. So all VSDs have the same room numbers, and no other entity has those room numbers.||(get-room 4478)|| n/a||
|-
|get-id ||entity||ID for the entity||(get-id (get-npc 100)) -> 100||n/a ||
|-
|get-hp-status-text||entity||string of the hp-status-text {unharmed, slightly-wounded, etc.}||(get-hp-status-text self) ||n/a||
|-
|get-owner||entity||owner object of entity||(get-owner self)-> Kay Dallben|| ||
|-
|get-container||entity||entity-object for container of entity. || (get-container self) || n/a ||
|-
|get-location||entity||String of location (currently including hyperlinks) if viewable without godmoding.|| || ||needs testing
|-
|get-storageform||entity get-entity-type-name||Returns a storageform for the entity. As of Y19D290 it works only on entities of types: NPC, Item, Ship, Room, Vehicle, Character (missing entities: Quest, Hook, Faction, Facility, Station, Droid). NOTE: If you use this in a script module you must bind the function (get-entity-type-name) ||(get-storageform (get-npc 22048668) get-entity-type-name) ||'("NPC" "Quest NPC" 22048668 "Vash Thompson") ||(load "swclib")
|-
|get-entity-from-storageform||storageform||Returns the entity object described in storageform. ''storageform'' is a list in the form of '("NPC" "Quest NPC" 22048668 "Vash Thompson")|| || ||(load "swclib")
|-
|get-first-n||n list||Returns the first ''n'' elements of ''list''. If ''n'' > (length ''list'') it returns the whole list. ''n'' is an integer and ''list'' is a list ||(get-first-n 3 '(a b c d e f g h i j)) ||'(a b c) ||(load "funlib")
|-
|get-name-typeof||entity-type||Returns just the Name component of the ''entity-type''. ''entity-type'' is a type, i.e. what you can get from (get-typeof ''entity'') ||(defvar held-in-hand (get-item FocusingCrystalid)) (get-name-typeof (get-typeof held-in-hand)) ||"Focusing Crystal" ||(load "funlib")
|-
|get-nth||haystack nth||Returns the ''nth'' element of ''haystack'' using <code>car</code> and <code>cdr</code> only. This does not call the PHP nth-of, so it can return a symbol. It might have performance issues for large lists or large nth ||(get-nth ?? ||?? ||(load "funlib")
|-
|}

==Functions for SWC Database==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
|faction-type|| player-NPC ||Character's faction's type || (faction-type (get-entity-faction character)) || Mining (Empty string if freelance) ||
|-
|faction-leader|| player-NPC ||Character's faction's leaders name || (faction-leader (get-entity-faction character)) || Ellias (Empty String if freelance) ||
|-
|faction-website || player-NPC ||Character's faction's website URL ||(faction-website (get-entity-faction character)) || http://swcombine.com (Link) (Empty string if freelance) ||
|-
|city-name || player-NPC ||Current city name ||(city-name character) || City 327 ||
|-
|planet-name || player-NPC ||Current planet name ||(planet-name character)|| Glee Anselm ||
|-
|system-name|| player-NPC ||Current system name ||(system-name character)|| Danju ||
|-
|sector-name|| player-NPC ||Current sector name ||(sector-name character)||Tapani ||
|-
|}

==Time Related Functions==
Functions that are useful in the tracking and manipulation of Time objects. Time objects are lists in the form of '(Y D H M S).

{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| cgt-year|| n.a. ||Gets current CGT year ||(cgt-year)|| 12 ||
|-
| cgt-day|| n.a. ||Gets current CGT day ||(cgt-day)||183 ||
|-
| cgt-hour|| n.a. ||Gets current CGT hour ||(cgt-hour)||23 ||
|-
| cgt-minute|| n.a. ||Gets current CGT minutes ||(cgt-minute)||59 ||
|-
| cgt-second|| n.a. ||Gets current CGT seconds||(cgt-second)||59 ||
|-
| timeofday|| n.a. ||Gets current phase of day ||(timeofday)||Morning, Afternoon, Evening ||
|-
| now-time|| n.a. ||Returns the 'time' object for Now ||(now-time)|| || (load "timelib")
|-
| now-seconds|| n.a. ||Returns the seconds for Now ||(now-seconds)|| || (load "timelib")
|-
| now-plus-days|| amount ||Add amount to Now in days ||(now-plus-days 3)|| a time object that is 3 days from Now|| (load "timelib")
|-
| now-plus-hours|| amount ||Add amount to Now in hours||(now-plus-hours 5)|| a time object that is 5 hours from Now || (load "timelib")
|-
| now-plus-minutes|| amount ||Add amount to Now in minutes ||(now-plus-minutes 18)|| a time object that is 18 minutes from Now || (load "timelib")
|-
| now-plus-seconds|| amount ||Add amount to Now in seconds||(now-plus-seconds 55)|| a time object that is 55 seconds from Now || (load "timelib")
|-
| timer-end-time|| amount-or-time &ydhms start-time ||Returns a time object that marks the end of a timer of length amount-or-time beginning on start-time. The ydhms defaults to 'm (minutes) and can be 'y 'd 'h 'm 's to indicate what units amount-or-time is in. start-time defaults to now-time but is a time object to denote the start time of the timer. ||1. (timer-end-time 30) 2. (timer-end-time 5 'h '(17 192 13 57 05))||1. a time object that is 30 minutes from Now (the same as (now-plus-minutes 30) i.e. 30 minutes from CGT at the time of script execution 2. '(17 192 18 57 05) i.e. 5 hours from Y17 D192 at 13:57:05 being Y17D192 18:57:05 || (load "timelib")
|-
| time-to-string|| time &format||Converts a time object to a string. format defaults to 'YDHMS ||If time '(17 192 18 20 15) then: 1. (time-to-string time 'YDHMS) 2. (time-to-string time 'YYDDHHMMSS) 3. (time-to-string time 'YsDsHsMsSs)|| 1. "Y17 D192 18:20:15" 2. "Year 17 Day 192 18:20:15" 3. "Years: 17 Days: 192 Hours: 18 Minutes: 20 Seconds: 15"|| (load "timelib")
|-
| cmp-time|| timeA timeB ||Basic comparison of two time objects. Returns true if equal ||(cmp-time)|| || (load "timelib")
|-
| fix-improper-time|| time ||Corrects an improper time object. "Improper" refers only to D, H, M, S being out of bounds. -60 < M < 60; -60 < S < 60; -23 < H < 23; -365 < D < 365 || || || (load "timelib")
|-
| add-n|| time amount ||Adds that amount of ''n'' to the ''time''. ''n'' is any of seconds mins hrs days years || || || (load "timelib")
|-
| add-times|| timeA timeB ||Returns the time object which is the sum of ''timeA'' and ''timesB''. Proper format. || || || (load "timelib")
|-
| add-ydhms-to|| time ydhms amount ||All-encompassing time-addition function. Adds ''amount'' 'y 'd 'h 'm or 's to ''time''. You can also use 0, 1, 2, 3 or 4 to refer to year, day, hour, minutes or seconds respectively, for ''ydhms'' || || || (load "timelib")
|-
| sub-times|| timeA timeB ||Returns the time object which is ''timeA'' minus ''timesB'' || || || (load "timelib")
|-
| diff-times|| timeA timeB ||Returns the time object which is the smalles difference of ''timeA'' and ''timeB'' || || || (load "timelib")
|-
| to-seconds|| time ||Converts ''time'' into seconds || || || (load "timelib")
|-
| to-time|| seconds ||Converts ''seconds'' into time || || || (load "timelib")
|-
|}

==Strings==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| abc ||n.a.||List of strings comprising the alphabet, lowercase|| || || (load "swclib")
|-
| ABC ||n.a.||List of strings comprising the alphabet, uppercase|| || || (load "swclib")
|-
| numstr||n.a.||List of strings from 1 to 9, rather than numbers|| || || (load "swclib")
|-
| aurebesh-caps ||n.a.||List of strings comprising the Aurebesh alphabet, with the initial letter capitalised|| ||"Aurek" "Besh" ... || (load "swclib")
|-
| aurebesh-lc ||n.a.||List of strings comprising the Aurebesh alphabet, all lowercase|| || "aurek" "besh" ... || (load "swclib")
|-
| trim || ||?? || || ?? ||
|-
| flash||type message ||Shows a flashing message to the player to provide non-conventional extra information, for example to indicate that a journal entry was added. ''type'' is one of: 'good 'bad 'info, ''message'' is a string ||(flash 'good "You have received 25 XP for helping to free the Jawas" || ||
|-
| enum|| ||Retrieves a named value from a specific enum ||(enum 'entityType 'room) ||Retrieves the entity type value for rooms ||
|-
| enum-values|| ||Retrieves all values from an enum || || ||
|-
| substr||string start &length ||Carves out a portion of a string. ''start'' is the position of the first character in the ''string'' you want to get, and ''length'' is the number of characters you want (default is to the end of the ''string''). Positions begin at 0 for the first character. You can also use a negative number to indicate you want to start "that many" characters from the end of the string ||1. (substr "I like cheese" 2) 2. (substr "I like cheese" 0 6) 3. (substr "I like cheese" -6) ||1. "like cheese" 2. "I like" 3. "cheese" ||
|-
| strpos||string find start ||Looks in ''string'' for the string ''find'' starting to look at position ''start'', and returns the position in ''string'' where it finds it ||1. (strpos "I like cheese" "like") 2. (strpos "I like cheese" " ") 3. (strpos "I like cheese" " " 2) ||1. 2 2. 1 3. 6 (looking for a space but beginning after the first space) ||
|-
|}

==Lists==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| join||separator-character list||Combines the elements of ''list'' with the ''separator-character'' to form a string||(join ", " (list "Green" "Blue" "Yellow")) ||"Green, Blue, Yellow, " || (load "funlib")
|-
| map||function list||Calls ''function'' for each member of ''list'' and returns the list of results||(map (lambda (x) (+ x 2)) (list 1 0 4)) ||(3 2 6)|| (load "funlib")
|-
| apply-foreach||function list||Calls ''function'' once for each member in ''list'', using the element as the single parameter. Returns #f (i.e., does not return a list of results)||(apply-foreach (lambda (x) (say (x)) (list "I like" "cheesy poofs." "Do you?")) ||I like cheesy poofs. Do you? || (load "funlib")
|-
| append||list element||Adds ''element'' to the end of ''list'' ||(append (list 1 2) 3) ||(1 2 3) || (load "funlib")
|-
| list-append||list1 list-to-append||Adds all the elements of the list ''list-to-append'' to the end of ''list1'' ||(list-append '(1 2) '(3 4)) ||'(1 2 3 4) || (load "funlib")
|-
| reduce||function init list||Reduces a list to a single value, using the combiner ''function'' provided, which function takes two inputs ''init'' and ''(car list)'' ||(reduce (lambda (x y) (+ x (* 2 y))) 0 (list 1 2 3)) ||12 [i.e. (((0 + 2*1) + (2*2)) + (2*3)) ] || (load "funlib")
|-
| repeat-fn||function num-times object||Repeats ''function'' for the number of ''num-times'' on ''object'' ||(repeat-fn (lambda (x) (+ x 1)) 4 0)||4|| (load "funlib")
|-
| rand-from-list-unique||n list||Returns a list of ''n'' elements taken randomly from ''list'', without any duplicates, even if an element appears multiple times in ''list''. ''n'' is an integer and ''list'' is a list. Note that currently this returns a list of strings if the element chosen is a symbol, due to PHP ||(rand-from-list-unique 7 '(a b c d a a q)) ||'("c" "d" "a" "b" "q")|| (load "funlib")
|-
| find-first-of||vals list-to-search (matchfun? eq?)||Returns a list of the first value in ''vals'' found in ''list-to-search'' and the first position (integer with 0 = first element) in list-to-search where vals is found. ''vals'' is an atom or a list of atoms to look for in list-to-search||(find-first-of (list 0 2 5) (list 1 3 2 7 5 0))||(list 2 2)|| (load "funlib")
|-
| find-in||atom list-to-search (start-position -1) (matchfun? eq?)||Returns the first position (integer with 0 = first element) where ''atom'' is found in ''list-to-search''||(find-in 7 (list 3 6 1 7 3 9 7))||3|| (load "funlib")
|-
| zip||list1 list2||Returns a list of pairs of the corresponding elements of list1 and list2. list1 and list2 must be lists of atoms of equal length||(zip '(1 2 3 4) '(a b c d))||'((1 a) (2 b) (3 c) (4 d))|| (load "funlib")
|-
| without||needle haystack ||Returns a list equal to ''haystack'' with all occurrences of ''needle'' removed. ''haystack'' is a list of atoms and ''needle'' is an atom||(without "blue" (list "red" "yellow" "blue" "orange" "blue" "white")) ||(list "red" "yellow" "orange" "white")|| (load "funlib")
|-
| l-to-csv||my-list ||Returns a csv-concatenated list of the elements of ''my-list''. ''my-list'' is a list of atoms which are convertible to strings ||(l-to-csv '(1 b a 3 d c)) ||'("1,b,a,3,d,c")|| (load "funlib")
|-
| replace-nth||my-list n value||Returns a list which is a copy of ''my-list'' with the nth value changed. ''my-list'' is a list, ''n'' is an integer, ''value'' is a s-expression. Note: the first element of a list is 0. ||(replace-nth '(a b c d e f g) 3 "Hornswaggle") ||'( a b c "Hornswaggle" e f g) || (load "funlib")
|-
| matchup||val searchlist fetchlist ||Finds the position of the first occurrence of ''val'' in ''searchlist'', and returns the same position element of ''fetchlist''. ''val'' is a value to search for, ''searchlist'' is a list to search in, and ''fetchlist'' is the list from which to return the corresponding element. Note: this returns a string instead of a symbol if the corresponding element of ''fetchlist'' is a symbol ||(matchup "b" '("a" "b" "c" "d")) '("A monkey" "An eagle" "A lion" "A snake")) ||"An eagle"|| (load "funlib")
|-
| remove-first||needle haystack ||Returns ''haystack'' without the first occurrence of ''needle'' located in it. ''needle'' is an atom, ''haystack'' is a list ||(remove-first x '(1 2 4 x f x 4)) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| remove-nth-of||haystack nth ||Returns ''haystack'' without the ''nth'' element. ''haystack'' is a list, ''nth'' is an integer. Note: the first element of a list is the 0th element ||(remove-nth-of '(1 2 4 x f x 4) 3) ||'(1 2 4 f x 4)|| (load "funlib")
|-
| ziplets||list-of-lists ||Returns a list of n-lets made up of the corresponding elements of each list in list-of-lists. ''list-of-lists'' is a list of lists of atoms ||(ziplets (list (list "I" "You" "We all") (list "scream" "scream" "scream") (list "for ice cream" "for ice cream" "for ice cream"))) ||(("I" "scream" "for ice cream") ("You" "scream" "for ice cream") ("We all" "scream" "for ice cream")) || (load "funlib")
|-
| sublist-firstof||list-of-lists ||Returns a list of the <code>car</code> of each sublist || || || (load "funlib")
|-
| rand-from-list || || || || ||
|-
|}

==Conditional Statements==
{| class="wikitable sortable" border="1" cellspacing="0" cellpadding="5" align="center"
! Function Name
! Required &Optional ("&") Parameters
! Description
! Example Text
! Example Evaluation
! Notes
|-
| case||val caselist &compfun||''val'' is the value to check against; each case in ''caselist'' which is a list of <code>case</code> lists in the form `(checkval ,toDo); ''&compfun'' is an optional function which takes 2 parameters and outputs #t or #f. Default is <code>eq?</code>. Note: <code>eq?</code> doesn't work on lists, so only use atoms for the checkval. It is also possible to write a <code>case</code> type in longer form, as follows: (list (list "blue" (set-var! x "blue")) (list "yellow" (set-var! y "yellow"))) ||`(("blue" ,(set-var! x "blue")) ("yellow" ,(set-var! y "yellow"))) || || (load "funlib")
|-
| cond|| [test result] ||''test'' is a s-expression that evaluates to #t or #f, ''result'' is a s-expression to execute if true ||(cond [is-owner? (say "Hi, Boss!")] [#t (say "Hello World!")]) || ||
|-
|}

*[[Scripting]]
*[[SWC LISP/Debugging and Errors]]
*[[SWC LISP/Admin-Only Functions]]
*[[SWC LISP/Modules]]

[[Category:SWC LISP]]